Index of values

This is a combinator to allow the service to take several parameters (see examples above) Warning: it is a binary operator.

a service sp cont () creates a link to service.

a service sp cont () creates a link to service.

This attribute assigns an access key to an element.

This attribute specifies a form processing agent.

This attribute specifies the character encoding of the resource designated by the link.

When the type attribute has the value "radio" or "checkbox", this boolean attribute specifies that the button is on.

This attribute assigns a class name or set of class names to an element.

This attribute specifies the visible width in average character widths.

This attribute specifies the location of a Web resource, thus defining a link between the current element (the source anchor) and the destination anchor defined by this attribute.

This attribute specifies the base language of the resource designated by href and may only be used when href is specified.

This attribute assigns a name to an element.

5.9.

This attribute assigns the control name.

XHTML 1.1 has removed the name attribute from several elements:

This attribute describes the relationship from the current document to the anchor specified by the href attribute.

This attribute is used to describe a reverse link from the anchor specified by the href attribute to the current document.

This attribute specifies the number of visible text lines.

When set, this boolean attribute specifies that this option is pre-selected.

This attribute specifies the position of the current element in the tabbing order for the current document.

This attribute offers advisory information about the element for which it is set.

This attribute gives an advisory hint as to the content type of the content available at the link target address.

This attribute specifies the initial value of the control.

Write a message in access.log

add table key value associates value to key.

Adds an element to the list, and possibly returns the element that has been removed if the maximum size was exceeded.

add_cookie c cookie_table adds the cookie c to the table cookie_table.

add_cookies newcookies oldcookies adds the cookies from newcookies to oldcookies.

Add a finalizer function

Adds non localized GET parameters to a service

Adds non localized POST parameters to a service

Add the element and all its subelements to a class.

Add the element to a class.

Takes all the suffix, as long as possible, as a (slash separated) string list

all_suffix_regexp r d s takes all the suffix, as long as possible, matching the regular expression r, name s, and rewrite it in d.

Takes all the suffix, as long as possible, as a string

Takes all the suffix, as long as possible, with a type specified by the user.

Use this if you want to take any parameters.

Convenient function for raising Error_in_config_file exceptions with a sprintf-formatted argument.

Same as Ocsigen_http_client.raw_request, but does not try to reuse connections.

bool s tells that the service takes a boolean as parameter, labeled s.

Creates a checkbox <input> tag that will have a boolean value.

Creates a checkbox <input> tag that will have a boolean value.

Creates a <button> tag with no value.

Creates a <button> tag with no value.

Cancel the stream, i.e.

Remove all data from the request cache

clear t remove all data from t

Clear the contents of all the existing caches

Returns the connection

Returns the id number of the connection

Close all persistent sessions for one session name.

Close all service sessions for one session name.

Close all persistent and volatile sessions for one session name.

Close all volatile data sessions for one session name.

Close all volatile (service and volatile data) sessions for one session name.

Close Eliom's current persistent session if opened (destroying all persistent data for that user)

Close Eliom's current service session, if opened

Close Eliom's current sessions if opened (service session, volatile data session and persistent session).

Close Eliom's current data session, if opened (destroying all session data for that user)

Close Eliom's current volatile session if opened (both service session and volatile data session) (destroying all session data for that user).

compute_new_ri_cookies now path ri_cookies cookies_to_set adds the cookies from cookies_to_set to ri_cookies, as if the cookies add been send to the browser and the browser was doing a new request to the url path.

Write a message in the console (if not called in silent mode)

Write a message in the console (if not called in silent mode)

Consume without cancelling.

creates a non empty step.

Given the local file file, with a request originating at url url, returns a viewable content of file.

Conversion fonction from Eliom cookies to server cookies.

string s tells that the service takes as parameters the coordinates of the point where the user were clicked on an image.

creates a new table

creates a table on hard disk where you can store the session data for all users.

creates a table in memory where you can store the session data for all users.

Creates a <link> tag for a Cascading StyleSheet (CSS).

Creates a <link> tag for a Cascading StyleSheet (CSS).

Returns the value of the current buffer

Write a message only in debugging mode (-V option) - Non cooperative

Write a message only in debugging mode (-V option) - Non cooperative

Same as debug without new line at the end - Non cooperative

Same as debug without new line at the end - Non cooperative

Functions related to the default charset in the association

Default values, obtained by reading the file specified by Ocsigen_config.get_mimefile

Default result to use as a base for constructing others.

Sender with only the server name, and HTTP/1.1

Compile a do_not_serve structure into a regexp.

If present and true in request data, it means that the previous coservice does not exist any more

If present in request data, means that the service session cookies does not exist any more.

creates an empty step.

All files are mapped to no_charset

result for an empty page.

Read more data in the buffer

Write a message in errors.log

file s tells that the service takes a file as parameter, labeled s.

Creates an <input> tag for sending a file

Creates an <input> tag for sending a file

Finalize the stream

find table key gives the value associated to key.

float s tells that the service takes a floating point number as parameter, labeled s.

Creates a <button> tag with float content

Creates a <button> tag with float content

Creates a checkbox <input> tag that will have a float value.

Creates a checkbox <input> tag that will have a float value.

Same for a float value

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type float

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type float

Creates an <input> tag for a float

Creates an <input> tag for a float

Creates a <select> tag for float values.

Creates a <select> tag for float values.

Creates a radio <input> tag with float content

Creates a radio <input> tag with float content

Creates a <select> tag for float values.

Creates a <select> tag for float values.

Iterator on persistent sessions.

Iterator on service sessions.

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.

Legacy interface for fold_step

Iterator on data sessions.

Generic forms.

get pv gives the value of pv

get t k returns the current binding of k in t or raises Not_found

call this function if you decide to start reading a stream.

EXPERIMENTAL -- May evolve in the future.

returns current parameters of the URL (GET parameters) (even those that are for subsequent services, but not previous actions)

returns all parameters in the body of the HTTP request (POST parameters) (even those that are for another service)

This function combines all the parsers registered with register_basic_authentication_method.

returns the information of the configuration file concerning that site (between <site> and </site>).

returns the default charset for this site

returns information from the configuration files.

returns the cookies sent by the browser

returns the full path of the URL using the type Ocsigen_lib.url_path

returns the full path of the URL as a string.

returns the sub path of the URL using the type Ocsigen_lib.url_path.

returns the sub path of the URL as a string.

returns the hostname declared in the config file (<host defaulthostname="...">).

returns the port number declared in the config file (<host defaulthttpport="...">).

returns the https port number declared in the config file (<host defaulthttpsport="...">).

returns the list of names of service sessions expired for the current request.

returns the size of the file.

get_form service sp formgen creates a GET form to service.

get_form service sp formgen creates a GET form to service.

returns the full URL as a string

returns the parameters of the URL (GET parameters) that concern the running service.

Returns the timeout for persistent sessions (server side).

Returns the timeout for service sessions (server side).

Returns the timeout for "volatile data" sessions (server side).

returns the hostname that has been sent by the user agent.

Returns the hostname to be used for absolute links or redirections.

returns the hostname used for absolute links.

returns all parameters of the URL (GET parameters) as sent initially by the browser

returns true if the coservice called has not been found.

returns non localized parameters in the URL.

returns non localized POST parameters.

get_non_localized_get_parameters ~sp p decodes and returns non localized GET parameters specified by p if present.

get_non_localized_post_parameters ~sp p decodes and returns non localized POST parameters specified by p if present.

returns the name the file had on the client when it has been sent.

returns the full path of the URL as first sent by the browser (not changed by previous extensions like rewritemod)

returns the full path of the URL as first sent by the browser (not changed by previous extensions like rewritemod)

returns the parameters of the URL (GET parameters) that do not concern the running service.

returns the value of the Eliom's cookies for one persistent session.

returns the group to which belong the persistent session.

None means default session name

returns the persistent session timeout for one user.

returns persistent non localized parameters in the URL.

Fails with lwt exception Not_found if no data in the table for the session.

gets persistent session data for the current persistent session (if any)

Returns the port to be used for absolute links or redirections.

returns the parameters in the body of the HTTP request (POST parameters) that concern the running service

returns the HTTP error code sent by the Ocsigen extension that tried to answer to the request before Eliom.

returns the internet address of the client, using the type Unix.inet_addr (defined in OCaml's standard library).

returns the internet address of the client as a string

returns all the information about the request and config.

returns a table in which you can store all the data you want during a request.

returns all the information about the request.

returns the port of the server.

returns the value of Eliom's cookies for one service session.

returns the group to which belong the service session.

None means default session name

returns the timeout for current service session.

returns the name of the sessions to which belongs the running service (None if it is not a session service)

returns the root of the site.

returns true if https is used, false if http.

returns the suffix of the current URL

returns the filename used by Ocsigen for the uploaded file.

returns the name of the user agent that did the request (usually the name of the browser).

returns the value of Eliom's cookies for one "volatile data" session.

returns the group to which belong the data session.

None means default session name

returns the timeout for current volatile data session.

Raises Not_found if no data in the table for the session.

gets session data for the current session (if any).

hierarchical_menu_breadth_first menu constructs a function taking as parameters a service and ~sp (server parameters) and displaying a hierarchical menu for this service.

hierarchical_menu_depth_first menu constructs a function taking as parameters a service and ~sp (server parameters) and displaying a hierarchical menu for this service.

The same, but forcing https

The same, but forcing https

The same, but forcing https.

The same, but forcing https.

Creates an <input type="image" name="..."> tag that sends the coordinates the user clicked on

Creates an <input type="image" name="..."> tag that sends the coordinates the user clicked on

int s tells that the service takes an integer as parameter, labeled s.

int32 s tells that the service takes a 32 bits integer as parameter, labeled s.

Creates a <button> tag with int32 content

Creates a <button> tag with int32 content

Creates a checkbox <input> tag that will have an int32 value.

Creates a checkbox <input> tag that will have an int32 value.

Same for a 32 bits integer value

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int32

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int32

Creates an <input> tag for a 32 bits integer

Creates an <input> tag for an integer

Creates a <select> tag for int32 values.

Creates a <select> tag for int32 values.

Creates a radio <input> tag with int32 content

Creates a radio <input> tag with int32 content

Creates a <select> tag for int32 values.

Creates a <select> tag for int32 values.

int64 s tells that the service takes a 64 bits integer as parameter, labeled s.

Creates a <button> tag with int64 content

Creates a <button> tag with int64 content

Creates a checkbox <input> tag that will have an int64 value.

Creates a checkbox <input> tag that will have an int64 value.

Same for a 64 integer value

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int64

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int64

Creates an <input> tag for a 64 bits integer

Creates an <input> tag for an integer

Creates a <select> tag for int64 values.

Creates a <select> tag for int64 values.

Creates a radio <input> tag with int64 content

Creates a radio <input> tag with int64 content

Creates a <select> tag for int64 values.

Creates a <select> tag for int64 values.

Creates a <button> tag with int content

Creates a <button> tag with int content

Creates a checkbox <input> tag that will have an int value.

Creates a checkbox <input> tag that will have an int value.

Same for an integer value

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type int

Creates an <input> tag for an integer

Creates an <input> tag for an integer

Creates a <select> tag for int values.

Creates a <select> tag for int values.

Creates a radio <input> tag with int content

Creates a radio <input> tag with int content

Creates a <select> tag for int values.

Creates a <select> tag for int values.

Iterator on persistent sessions.

Iterator on service sessions.

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.

Legacy interface for iter_step

Iterator on data sessions.

Creates a <script> tag to add a javascript file

Creates a <script> tag to add a javascript file

Size of a table.

The service takes a list of parameters.

The list to which the node belongs

The same but taking a cooperative function.

The same but taking a cooperative function.

The same but taking a cooperative function.

The same but taking a cooperative function.

creates a new stream

create a new key for each data you want to save

create a new specification for non localized parameters.

make_persistent store name default find a persistent value named name in store store from database, or create it with the default value default if it does not exist.

Same as make_persistent but the default value is evaluated only if needed

Like make_uri_components, but also creates a table of post parameters.

Like make_uri_components, but also creates a table of post parameters.

Creates the string corresponding to the beginning of the URL, containing the scheme (protocol), server and port number (if necessary).

Creates the string corresponding to the beginning of the URL, containing the scheme (protocol), server and port number (if necessary).

Creates the string corresponding to the relative URL of a service applied to its GET parameters.

Creates the string corresponding to the relative URL of a service applied to its GET parameters.

Creates the URL for a service.

Creates the URL for a service.

Creates the URL for a service.

Creates the URL for a service.

Creates a menu

Move a node from one dlist to another one, without finalizing.

Creates a coservice.

Creates a non-attached coservice, that is, services that do not correspond to a precise path in the URL.

Creates an service for an external web site.

Creates a coservice with POST parameters

Creates a non attached coservice with POST parameters.

Creates an service that takes POST parameters.

new_service ~path:p ~get_params:pa () creates an Eliom_services.service associated to the path p, taking the GET parameters pa.

get the next step of a stream.

A text included in each page

returns a stream reading from a file.

returns a stream containing a string.

Open a store (and create it if it does not exist)

Open a table (and create it if it does not exist)

Use this if you want one or some parameters to be optional

Parses the hostfilter field of the configuration file, which is a disjunction of possible hostnames (that can themselves contain wildcards)

Parsing of a file containing mime associations, such as /etc/mime-types

Parse a size ("infinity" or using SI or binary units, e.g.

parse_size_tag tag s parses a size (same syntax as parse_size).

Parse a string (PCDATA) as XML content.

parse_string_tag tag s parses a string (same syntax as parse_string).

post_form service sp formgen creates a POST form to service.

post_form service sp formgen creates a POST form to service.

creates a new service by preapplying a service to GET parameters.

Same as ** above

Use this if you want to use this parameter with a radio button.

Creates a <button> tag with untyped string content

Creates a <button> tag with untyped string content

Creates a checkbox <input> tag with untyped content.

Creates a checkbox <input> tag with untyped content.

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and an untyped value

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and an untyped value

Creates an untyped <input> tag.

Creates an untyped <input> tag.

Creates a <select> tag for any (untyped) value.

Creates a <select> tag for any (untyped) value.

Creates a radio <input> tag with untyped string content (low level)

Creates a radio <input> tag with untyped string content (low level)

Do an HTTP request (low level).

Creates a <select> tag for any (untyped) value.

Creates a <select> tag for any (untyped) value.

Creates a <textarea> tag for untyped form

Creates a <textarea> tag for untyped form

Constructs a relative link (low level).

regexp r d s tells that the service takes a string that matches the regular expression r as parameter, labeled s, and that will be rewritten in d.

registers an service in the public service table with the associated handler function.

This function registers an authentication plugin: it adds a new parser to the list of available authentication schemes.

Use a prefix for all your cammands when you want to create extension specific commands.

This function is used to specify the initialization function for Eliom modules linked dynamic or statically into the server.

For each extension generating pages, we register its name and six functions: a function fun_site of type parse_config. This function will be responsible for handling the options of the configuration files that are recognized by the extension, and potentially generating a page., a function user_fun_site of type parse_user_config which has the same role as fun_site, but inside userconf files. Specify nothing if your extension is disallowed in userconf files. Otherwise, compared to fun_site, you can selectively disallow some options, as user_fun_site must define only safe options (for example it is not safe to allow such options to load a cmo specified by a user, or to execute a program, as this program will be executed by ocsigen's user). Note that user_fun_site will be called for every request, whereas the fun_site is called only when starting or reloading the server., a function begin_init that will be called at the beginning of the initialisation phase of each site, and each time the config file is reloaded., a function end_init that will be called at the end of the initialisation phase of each site, a function init_fun that will be called just before registering the extension, taking as parameter the configuration options between <extension> and </extension>. This allows to give configuration options to extensions. If no function is supplied, the extension is supposed to accept no option (and loading will fail if an option is supplied), a function exn_handler that will create an error message from the exceptions that may be raised during the initialisation phase, and raise again all other exceptions Moreover, if the optional parameter ?respect_pipeline is true, the extension will ask the server to respect the order of the pipeline.

registers a handler for a service in the session table.

Same as new_coservice followed by register

Same as new_coservice' followed by register

Same as new_coservice followed by register_for_session

Same as new_coservice' followed by register_for_session

Same as new_post_coservice followed by register

Same as new_post_coservice' followed by register

Same as new_post_coservice followed by register_for_session

Same as new_post_coservice' followed by register_for_session

Same as new_post_service followed by register

Same as new_service followed by register

remove table key removes the entry in the table if it exists

Removes an element from its list.

remove the n oldest values (or less if the list is not long enough) ; returns the list of removed values

removes session data for the current persistent session (but does not close the session).

removes session data for the current session (but does not close the session).

replace_if_exists table key value associates value to key only if key is already bound.

raises Not_found is the directory does not exist

Finds filename in the filesystem, with a possible redirection if it is a directory.

Parsing URLs.

send an HTTP message.

Sending an error page

set pv value sets a persistent value pv to value

set t k v associates v to k in t

Use this if you want your service to take several parameters with the same name.

Sets the maximum number of persistent data sessions in a session group (see above).

Sets the maximum number of service sessions in a session group (see above).

Sets the maximum number of service sessions in a subnet (see above).

Sets the maximum number of volatile data sessions in a session group (see above).

Sets the maximum number of volatile data sessions in a subnet (see above).

Sets the maximum number of volatile sessions (data and service) in a session group (see above).

Sets the maximum number of volatile sessions (data and service) in a subnet (see above).

Allows to use your own error pages (404, or any exception during page generation).

set a function to be called automatically on a piece of data just before it disappears from the list (either by explicit removal or because the maximum size is exceeded)

Sets the timeout for persistent sessions (server side).

Sets the timeout for service sessions (server side).

Sets the timeout for volatile (= "in memory") data sessions (server side).

Sets the timeout for volatile (= "in memory") sessions (both service session and volatile data session) (server side).

Sets the mask for subnet (IPV4).

Sets the mask for subnet (IPV6).

Sets the maximum number of service sessions in the current session group (or for the client sub network, if there is no group).

Sets the maximum number of volatile data sessions in the current session group (or for the client sub network, if there is no group).

change the maximum size ; returns the list of removed values, if any.

Sets the cookie expiration date for the persistent session (see above).

sets the group to which belong the persistent session.

sets the timeout for persistent session (server side) for one user, in seconds.

sets persistent session data for the current persistent session

Use this function to make an action just before sending the result (for example observe the headers that will be sent).

Set the rowspan attribute for the element.

Sets the cookie expiration date for the current service session (see above).

sets the group to which belong the service session.

sets the timeout for service session (server side) for one user, in seconds.

Sets the cookie expiration date for the current data session (see above).

sets the group to which belong the volatile data session.

sets the timeout for volatile data session (server side) for one user, in seconds.

Sets the cookie expiration date for the current volatile sessions (service and data) (see above).

sets session data for the current session.

sets the timeout for volatile sessions (service and volatile data) (server side) for one user, in seconds.

Skips data.

Start the server (does not return)

A predefined service that correponds to the directory where static pages are.

Like static_dir, but allows to put GET parameters

stream_want s len Returns a stream with at least len bytes in the buffer if possible

string s tells that the service takes a string as parameter, labeled s.

Creates a <button> tag with string content

Creates a <button> tag with string content

Creates a checkbox <input> tag that will have a string value.

Creates a checkbox <input> tag that will have a string value.

It is possible to send a value together with the coordinates (<input type="image" value="..." ...>) (Here a string)

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type string

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of type string

Creates an <input> tag for a string

Creates an <input> tag for a string

Creates a <select> tag for string values.

Creates a <select> tag for string values.

Creates a string from a stream

A Uniform Resource Identifier, as per RFC2396.

Creates a radio <input> tag with string content

Creates a radio <input> tag with string content

Creates a <select> tag for string values.

Creates a <select> tag for string values.

Returns the tags <link rel="subsection" ...> and <link rev="subsection" ...> for the given hierarchical site.

Cut the stream at the position given by a string delimiter

Tells that the parameter of the service handler is the suffix of the URL of the current service.

suffix_const v is used only inside suffixes (do nothing for regular parameters).

Tells that the function that will generate the service takes a pair whose first element is the suffix of the URL of the current service, and the second element corresponds to other (regular) parameters.

This is a combinator to allow the service to take either a parameter or another one Warning: it is a binary operator.

This function may be used for services that cannot be interrupted (no cooperation point for threads).

returns the name of the table

Creates a <textarea> tag

Creates a <textarea> tag

Use that function for all impossible cases in exception handlers (try ... with ... | e -> unexpected_exception ... or Lwt.catch ...).

used for services that don't have any parameters

Unregister a service from global table

Unregister a service from session table

Remove the session from its group

remove the persistent session timeout for one user (and turn back to the default).

Remove the session from its group

remove the service session timeout for one user (and turn back to the default).

Remove the session from its group

remove the "volatile data" session timeout for one user (and turn back to the default).

remove the session timeout for one user for both service session and volatile data session (and turn back to the default).

Removes the element from its list without finalising, then adds it as newest.

Updates the mapping between extensions from a file to its charset.

Allows to use whatever type you want for a parameter of the service.

Creates a <button> tag with user_type content

Creates a <button> tag with user_type content

Creates a checkbox <input> tag that will have a "user type" value.

Creates a checkbox <input> tag that will have a "user type" value.

Same for a value of your own type

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of user defined type

Creates an <input type="image" name="..." value="..."> tag that sends the coordinates the user clicked on and a value of user defined type

Creates an <input> tag for a user type

Creates an <input> tag for a user type

Creates a <select> tag for user type values.

Creates a <select> tag for user type values.

Creates a radio <input> tag with user_type content

Creates a radio <input> tag with user_type content

Creates a <select> tag for user type values.

Creates a <select> tag for user type values.

A hyperlink to the W3C validator, including the logo.

A predefined non-attached action with special behaviour: it has no parameter at all, even non-attached parameters.

Same as void_coservice' but keeps non attached GET parameters.

Write a message in warnings.log

This function may return any I/O error from the channel, or a interrupted stream exception.

Ocsigen's compact printer for xhtml portions.

Ocsigen's pretty printer for xhtml portions.

Ocsigen's compact printer for xhtml portions.

Ocsigen's pretty printer for xhtml portions.

Ocsigen's compact printer for xhtml.

Ocsigen's pretty printer for xhtml.

Ocsigen's compact printer for xhtml.

Ocsigen's pretty printer for xhtml.