Index of values

The combinator p1 ** p2 allows one to define a service that takes a pair of parameters.

f =|< s is map f s.

s >|= f is map f s.

The function a service a_content get_params creates a <a> node that link to service applied to GET parameters get_params and whose content is a_content.

The function add_non_localized_get_parameters ~params ~service Adds non localized GET parameters params to service.

Like Eliom_service_sigs.S.add_non_localized_get_parameters but with POST parameters.

Takes the whole 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 the whole suffix, as long as possible, as a string

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

Use this if you want to take any parameters.

The function appl_self_redirect send page is an helper function required for defining Eliom_registration.Any service usable inside an Eliom application (Eliom_registration.App).

Unique identifier for this application.

Name of the application.

The function application_name () returns a <script> node that represents the javascript part of the application.

attach ~fallback ~service () attaches the preexisting pathless service service on the URL of fallback.

attrib my_data value creates a HTML attribute for the custom-data type my_data with value value for injecting it into an a HTML tree ().

bool s means that the service takes a Boolean as the parameter named s.

Creates a checkbox <input> tag of type bool.

Creates a <button> tag.

Creates a <button> tag with no value.

cast_http_result should only be used to register new output modules

If you know that the content you generated using Text.send or Streamlist.send is the same as some other kind, you can cast it with cast_unknown_content_kind for use with Any module.

The function check_file file is true if File.send file would effectively return the file (i.e.

The function check_file file is true if File.send file would effectively return the file (i.e.

Creates a checkbox <input> tag.

Call clean () to clear the tables from empty data.

client x is the client-side portion of x.

Returns the client react event.

Registers a client value datum for the next server section when executed in a global_data (cf.

Called at the end of every client or shared section.

Called at the end of each server or shared section.

coordinates s means that the service takes as parameters the coordinates of a point in an <input type="image" ...>.

Service definition

Create a new table.

create ?default ?reset_default x produces a pair s, f, where s is a (shared) reactive signal, and f is a shared function for updating the signal.

create param creates an Up event.

Create a custom data field by providing string conversion functions.

create s returns a channel sending the values returned by stream s.

create ?scope ?name ?size ?filter t creates a fresh bus.

create ?default ?reset_default l produces a pair l, f, where s is a (shared) reactive list, and f is a handle for manipulating the list.

See Eliom_registration_sigs.S_with_create.create.

Create a service and register it at the same time.

create_attached_get ~fallback ~get_params () attaches a new service on the path of fallback.

See Eliom_registration_sigs.S_with_create.create_attached_get.

Create an attached service and register it at the same time.

create_attached_post ~fallback ~post_params () attaches a new service on the path of fallback.

See Eliom_registration_sigs.S_with_create.create_attached_post.

Create an attached POST service and register it at the same time.

Same as create, but data is filtered through filter function before entering the bus.

create_from_events e returns a channel sending the values returned by the event stream e.

The function create_named_elt elt is equivalent to create_named_elt ~id:(new_elt_id ()) elt.

The function create_named_elt elt is equivalent to create_named_elt ~id:(new_elt_id ()) elt.

Create a custom data from a Json-deriving type.

The function create_named_elt ~id elt create a copy of the element elt that will be sent to client with the reference id.

The function create_named_elt ~id elt create a copy of the element elt that will be accessible through the name id.

create_newest s is similar to create ~scope:Eliom_common.site_scope s but only the last message is returned to the client.

create_request_elt ?reset elt creates a referable copy of elt.

create_request_elt ?reset elt creates a referable copy of elt.

create_unlimited s creates a channel which does not read immediately on the stream.

create f create a new tag that can be included into a value.

The function css_link ~uri () creates a <link> node that reference a Cascading StyleSheet (CSS).

Same for persistent data

Same for services

current_volatile_data_state ~scope returns the state corresponding to scope scope.

Deprecated.

The default options record for an eliom service.

The function default_protocol_is_https () returns true if there is option (<host defaultprotocol="https">)or false otherwise.

Deinitialise/deactivate the notification module for the current client.

Delete server-side (volatile and persistent) state data and services for a session, a group of sessions, a client process or a request.

Discard all services and persistent and volatile data for one scope.

Discard server side data for all clients, for the given scope.

Remove all services registered for clients for the given scope.

Remove current state data.

Discard all services and persistent and volatile data for every scopes.

Remove all services registered for the given scope (the default being `Session).

Discard external states

do_cache cache key value adds the association from key to value in cache, or replaces it if not already present.

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.

a wrapper that do not change the value

equal_identity is the same as equal_key but for values of type identity.

equal_key is a function testing the equality between two values of type key.

The function eref ~scope value creates an Eliom reference for the given scope and initialize it with value.

The function eref_from_fun works like the above Eliom_reference.eref, but instead of providing a value for the initial content, a function f for creating the initial content is provided (cf.

Convert any value to a Eliom_runtime.escaped_value for usage in the args argument to Eliom_syntax.client_value.

Returns true if the request was done by a client side Eliom program, which was expecting to receive a new HTML page to display inside the process.

extern ~prefix ~path ~meth () creates an external service, i.e., a service implemented by a remote server (not necessarily running Ocsigen/Eliom).

external_channel ~prefix ~name () declares an external channel.

file s means that the service takes a file as the parameter named s.

Creates an <input> tag for sending a file

filter_attrib a b amounts to the attribute a while b is true, and to no attribute while b is false.

find cache get_from_db key returns the value associated to key in cache.

Find a piece of data in local cache, without trying to fetch it from server.

float s means that the service takes a float as the parameter named s.

Iterator on persistent cookies.

Iterator on service cookies.

Fold all sessions in a groups, or all client processes in a session (volatile and persistent).

Iterator on data cookies.

Fold all sessions in a groups, or all client processes in a session.

get the value of a reference from outside the state.

get the value of a reference from outside the state.

The function get eref returns the current value of the Eliom reference eref.

returns the (string * float option) list corresponding to accept_language HTTP header of the request.

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

returns all files in he HTTP request (even those that are for another service)

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

The function get_config () returns the information of the configuration file concerning that site (between <eliommodule> and </eliommodule> or <eliom> and </eliom>).

The function get_config_default_charset () returns the default charset for this site.

The function get_config_info () returns the information concerning the current request from the configuration files (must be called during a request).

returns the cookies sent by the browser

returns the hostname used for absolute links, computed when launching the client side process for the first time.

returns the full path of the URL where the client-side process is running.

returns the port of the server, used when launching the client side process (not the current request).

returns true if https is used in the URL of the browser, false if http.

returns the sub path of the URL using the type Eliom_lib.Url.path.

returns the sub path of the URL as a string.

returns the values of Eliom's cookies for non persistent sessions sent by the browser.

Same as Ocsigen_config.get_debugmode.

The function get_default_hostname ()returns the hostname declared in the config file (<host defaulthostname="...">) or the default machine hostname.

The function get_default_port () returns the port number declared in the config file (<host defaulthttpport="...">) or 80 if undeclared.

The function get_default_sslport () returns the https port number declared in the config file (<host defaulthttpsport="...">) or 443 if undeclared.

returns the list of names of service sessions expired for the current request, for browser sessions and tab sessions.

returns the content type sent by the browser with the file (if any).

returns the size of the uploaded file.

The function get_form service 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 (server side) timeout for persistent states.

Returns the (server side) timeout for service states.

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

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

returns the hostname used for absolute links.

returns the HTTP method used for the request (usually GET or POST).

see Eliom_notif.ARG.equal_key

get_identity is a function returning a value of type identity corresponding to a client.

returns the GET parameters that have been ignored using <ignoredgetparams/> in config file.

returns the POST parameters that have been ignored using <ignoredpostparams/> in config file.

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 values of the Eliom's cookies for persistent sessions sent by the browser.

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

returns the group to which belong the persistent session.

returns the persistent state timeout for current user.

returns persistent non localized parameters in the URL.

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 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.

Get the infomration about cookies (timeouts, etc.)

returns the group to which belong the service session.

returns the number of sessions in the group.

returns the timeout for current service state.

Returns a list containing the names of all session group that are available for this site.

returns the root of the site.

returns true if https is used, false if http.

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

returns the suffix of the current URL

returns an Unix timestamp associated to the request

returns the filename used by Ocsigen for the uploaded file.

Given a parameter type, get the two functions that converts from and to strings.

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

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

returns the group to which belong the data session.

returns the number of sessions in the group.

returns the timeout for current volatile data state.

Returns whether client values created in the current context should be considered global

If a path is provided, we export through it a service for accessing the global data.

An auxiliary function for creating an HTML head elements.

The function hierarchical_menu_breadth_first site () constructs a hierarchical menu by exploring the hierarchical site description using a breadth_first algorithm: the whole menu for one level will be displayed, followed by the sub-menu leading to the current service, and so one.

The function hierarchical_menu_depth_first site () constructs a hieranrchical menu by exploring the hierarchical site description using a depth-first algorithm: the first menu item will be displayed, followed by the whole sub-menu for this item, then the second menu item with its sub-menu, and so on.

Like Eliom_service_sigs.S.static_dir, but forces HTTPS link

Like Eliom_service_sigs.S.static_dir_with_params, but forces HTTPS link

Creates an <input type="image" name="..."> tag.

returns true when currently handling a request.

Initialise the notification module for the current client.

Creates an <input> tag.

int s means that the service takes an integer as the parameter named s.

int32 s means that the service takes a 32-bit integer as the parameter named s.

int64 s means that the service takes a 64-bit integer as the parameter named s.

Returns whether it is an external service or not.

Checks during a request whether it is the initial request of the client process in this Eliom application.

Iterator on persistent cookies.

Iterator on all active service cookies.

Iter on all sessions in a groups, or all client processes in a session (volatile and persistent).

Iterator on data cookies.

Iter on all sessions in a groups, or all client processes in a session.

The function js_script ~uri () creates a <script> node that reference a javascript file.

Marshal an OCaml value into a string.

The service takes a list of parameters.

Make client process listen on data whose index is key

local x is the local portion of x.

Find a piece of data in local cache, without trying to fetch it from server.

Same as Eliom_form_sigs.S.get_form but taking a cooperative function for <form> content generation.

Same as Eliom_form_sigs.S.post_form but taking a cooperative function for <form> content generation.

Return a base-64 encoded cryptographic safe string of the given length.

Create a new specification for non localized parameters.

Same a Eliom_uri.make_uri_components, but also returns a table of post parameters.

Same as LINK.make_uri_components, but also returns a list of post parameters.

The function make_string_uri ~service get_params creates the string corresponding to the URL of the service service applied to the GET parameters get_params.

The function make_string_uri_from_components path get_params fragment build the corresponding string URL.

The function make_uri service get_params returns the URL of the service service applied to the GET parameters get_params.

The function make_uri_components service get_params returns the a triplet (path, get_params, fragment) that is a decomposition of the URL of service applied to the GET parameters get_params.

max_identity_per_resource is the initial size for the tables storing the data of clients listening on one given resource, fo best results it should be on the order of the expected number of clients that may listen on a given resource.

max_resource is the initial size for the hash table storing the data of clients listening on resources, for best results it should be on the order of the expected number of different resources one may want to be able to listen to.

The function menu elts (), where elts is a list of pair (service, content), creates a list of link towards the services.

Warning: the function will be executed with the current context

Warning: the function will be executed with the current context

The function modify eref f modifies the content of the Eliom reference eref by applying the function f on it.

Creates a multiple-selection <select> tag.

The combinator neopt p allows defining an optional parameter assumed to be None if empty.

The function new_elt_id () creates a new global HTML element identifier (see the Eliom manual for more information on ).

The function new_elt_id () creates a new HTML5 element identifier.

node s produces an 'a elt out of the shared reactive signal s.

node e is a server-side node corresponding to the client-side node e .

node e is a server-side node corresponding to the client-side node e .

node s produces an 'a elt out of the shared reactive signal s.

Call notify key n to send a notification n to all clients currently listening on data referenced by key.

ocaml s tells that the service is expecting some caml (client side) program to send some value of type 'a, marshaled.

of_react ?scope ?throttling ?name e create an asynchronous edge originating from e.

The combinator opt p allows defining optional parameters.

Process the configuration (same as the one returned by ) by a given specification (cf.

pcdata s produces a node of type [> Html_types.span] elt out of the string signal s.

pcdata is not implemented reactively for SVG.

Same for persistent data

The function post_form service formgen post_params creates a POST <form> to service preapplied to the POST parameters post_params.

The function preapply ~service parameters creates a new service by preapplying service to the GET parameters.

prepare f transforms server notifications into client notifications.

Same as Eliom_parameter_sigs.S.( ** ).

A parameter as radio f s specifies that the service takes an optional argument labeled s, of type f s.

Creates a radio <input> tag.

The function reconstruct_relative_url_path src dest returns a path to dest that is relative to src.

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.

See Eliom_registration_sigs.S.register.

The function register ~service handler associates the service to the function handler.

The function register_eliom_module mod f is used to register the initialization function f to be executed when then module mod is loaded by Ocsigen server.

The service reload_action is a predefined non-attached action with special behaviour: it has no parameter at all, even non-attached parameters.

Like Eliom_service_sigs.S.reload_action, but keeps non-attached GET parameters.

Like Eliom_service_sigs.S.reload_action, but forces HTTPS

Like Eliom_service_sigs.S.reload_action_hidden, but forces HTTPS

Creates a <select> tag.

More polymorphic version of Eliom_registration_sigs.send

The function send page builds the HTTP frame corresponding to page.

See Eliom_reg_sigs.PARAM.send_appl_content.

Whether the service is capable of sending application content when required.

server_function argument_type f creates a value of type .

Same for services

The function set eref v set v as current value of the Eliom reference eref.

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

Ask the browser to record a cookie.

The provided value serves as a default value for the optional parameter ~xhr in the functions Eliom_registration.*.{a, get_form, post_form, lwt_get_form, lwt_post_form} (cf.

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

Sets the maximum number of persistent data tab 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 tab service sessions in a session group (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 data tab sessions in a session group (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).

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

The set_exn_handler handler allows redefinition of error pages: 404 or any exception during page generation.

All client values created between set_global true and set_global false are considered global client values (cf.

Sets the (server side) timeout for persistent states.

Sets the (server side) timeout for service states.

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

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

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).

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

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

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

sets the group to which belong the persistent session.

sets the (server side) timeout for persistent state for current user, in seconds.

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

sets the group to which belong the service session.

sets the timeout for service state (server side) for current user, in seconds.

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

sets the group to which belong the volatile data session.

sets the (server side) timeout for volatile data state for current user, in seconds.

The predefined service static_dir allows one to create links to static files.

Like Eliom_service_sigs.S.static_dir, but allows one to put GET parameters

stream b returns the stream of data sent to bus b.

string s means that the service takes a string as the parameter named s.

The function structure_links site () returns the tags <link rel="subsection" ...> and <link rev="subsection" ...> for the given hierarchical site.

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.

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.

The combinator sum p1 p2 allows one to define service that expect either the parameter p1 or the parameter p2.

If synced l is true, then the server-side and client-side values of l are equal.

If synced s is true, then the server-side and client-side values of s are equal.

Creates a <textarea> tag

to_react e injects the up events e into react events so that it can be manipulated as a standard event.

to_signal ~init s converts the Lwt-wrapped signal s into a regular signal with initial value init.

Function to modify the global_app URI for some obscure reason

Specifying parameter as type_checker check t is equivalent as t but the check function is called after decoding the parameters, allowing you to make more checks on the parameters before the service handler is called.

Specifying parameter as unit is used for services that don't have any parameters

Make a listener stop listening on data key.

Stop listening on data key

The function unregister service unregister the service handler previously associated to service with Eliom_registration.Html.register, Eliom_registration.App.register or any other Eliom_registration.*.register functions.

The function unset eref reset the content of the Eliom reference eref to its initial value.

Ask the browser to remove a cookie.

Remove the session from its group.

remove the persistent state timeout for current user (and turn back to the default).

Remove the session from its group.

remove the service state timeout for current user (and turn back to the default).

Remove the session from its group.

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

The function uri_of_string f returns a URI whose content is equivalent to f ().

user_type ~of_string ~to_string s construct a parameter, labeled s, such that the server will have to use of_string and to_string to make the conversion between the OCaml representation of the parameter and it's representation as a string.

volatile_data_group_state ~scope n returns the state corresponding to the group named n in scope scope.

wait_timeout ~scope time waits for a period of inactivity of length time in the scope.

Record an CSS file to be included in Eliom_tools.F.html.

Record an (external) JavaScript file to be included in Eliom_tools.F.html.

Eliom_content.Xml.wrap page v is like Eliom_wrap.wrap v but it makes sure that all elts in v which are included in page are sent with empty content.

This function allows one to wrap a service handler easily depending on whether certain information is available or not.

write b x sends the value x on the bus b.