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.

if the client is inactive activate () launch a new xhr connection to start receiving server messages

see addEventListener

The function addEventListener elt evt handler attach the handler for the event evt on the element elt.

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

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.

see appendChild

appendChild e1 e2 inserts the element e2 as last child of e1.

see appendChild

appendChild e1 e2 inserts the element e2 as last child of e1.

see appendChildren

appendChildren e1 elts inserts elts as last children of e1.

see appendChildren

appendChildren e1 elts inserts elts as last children of e1.

Append to the body of the document.

For compatibility with server-side appl_self_redirect

Name of the application.

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

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

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.

Call a server side service that return an OCaml value.

(low level) Call a server side service and return the content of the resulting HTTP frame as a string.

Call a service and change the current page.

change_page_uri ?replace uri identifies and calls the client-side service that implements uri.

Changes the URL, without doing a request.

Creates a checkbox <input> tag.

childLength e returns the number of children of e

childLength e returns the number of children of e

children elt returns the list of html children of elt.

client x is the client-side portion of x.

after close b, stream b stops receiving new messages from the bus, but it is still possible to write to the bus.

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

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

Create a custom data field by providing string conversion functions.

Create a custom data field by providing string conversion functions.

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.

See Eliom_registration_sigs.S_with_create.create_attached_get.

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

See Eliom_registration_sigs.S_with_create.create_attached_post.

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

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

See Eliom_content.Html.Id.create_global_elt

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.

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 accessible through the name id.

See Eliom_content.Html.Id.create_named_elt

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.

See Eliom_content.Svg.Id.create_request_elt

See Eliom_content.Html.Id.create_request_elt

create_request_elt ?reset elt creates a referable copy of elt.

create_request_elt ?reset elt creates a referable copy of elt.

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

Deprecated.

Deprecated.

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

drop_configuration t restores the behaviour to the minimum of configuration without t.

Deprecated.

Deprecated.

Stop current program and load a new page.

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

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

Creates an <input> tag for sending a file

filter_attrib att on returns an attrib that behave like att when on is true and behave like if there was no attribute when on 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.

Returns the name of currently running Eliom application, defined while applying Eliom_registration.App functor.

Same as Ocsigen_config.get_debugmode.

get_dom element custom_data gets the custom_data from a JavaScript element (Js_of_ocaml.Dom_html.element ).

get_element id returns the HTML element in the DOM with the given id if it exists.

get_element id returns the HTML element in the DOM with the given id if it exists.

The function get_form service formgen creates a GET <form> to service.

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

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.

inactive occurs when the Active state is left (Cached or Dead)

Call this function if you want to be able to run your client side app before doing the first request, that is, when the client side app is not sent by the server.

Creates an <input> tag.

insertAfter ~after elt insert elt after after.

insertAfter ~after elt insert elt after after.

insertBefore ~before elt insert elt before before.

insertBefore ~before elt insert elt before before.

insertFirstChild p c inserts c as first child of p

insertFirstChild p c inserts c as first child of p

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.

is_active () returns the current activity state

Returns whether the application is sent by a server or started on client side.

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

Deprecated.

The service takes a list of parameters.

Load (or reload) in cache the piece of data from server

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.

Returns a Lwt thread that waits until the next page is loaded.

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.

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

Creates a multiple-selection <select> tag.

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

Creates a new configuration with default value.

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

See Eliom_content.Html.Id.new_elt_id

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

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

nextSibling elt returns the next element that has the same parent, if elt is not the last.

nextSibling elt returns the next element that has the same parent, if elt is not the last.

the function node s create an HTML5 elt from a signal s.

The function node s creates an SVG elt from a signal s.

Those two functions are the identity on client-side (the init argument is ignored).

Function node s create an HTML5 elt from a signal s.

The function node s creates an SVG elt from a signal s.

nth e n returns the nth child of e (first is 0)

nth e n returns the nth child of e (first is 0)

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

onactive is convenience function that attaches a handler to Events.active, which behaves exactly like fun f -> React.E.map f Events.active.

onbeforeunload f registers f as a handler to be called before changing the page the next time.

Run some code *before* the next page change, that is, before each call to a page-producing service handler.

Registers some code to be executed after loading the client application, or after changing the page the next time.

onunload f registers f as a handler to be called before page change.

The combinator opt p allows defining optional parameters.

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

parentNode elt returns the parent of elt, if any.

parentNode elt returns the parent of elt, if any.

Extracts path from a URL string.

After this function is called, the document head is no longer changed on page change.

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.

previousSibling elt returns the previous element that has the same parent, if elt is not the first.

previousSibling elt returns the previous element that has the same parent, if elt is not the first.

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 first argument describes the calling function (if any) in case of an error.

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

See Eliom_registration_sigs.S.register.

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

release ~key o removes the association between the value v and the value associated to key.

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

see removeChild

The function removeChild e1 e2 removes for e2 from the list of e1 children.

see removeChild

removeChild e1 e2 removes for e2 from the list of children of e1.

see removeChildren

The function removeChildren e1 removes e1 children.

see removeChildren

removeChildren e1 removes all children of e1.

removeSelf e removes element e from the DOM.

removeSelf e removes element e from the DOM.

see replaceChild

The function replace e1 e2 e3 replaces for e2 by e3 in the list of e1 children.

see replaceChild

replace e1 e2 e3 replaces e3 by e2 in the list of children of e1.

see replaceChildren

The function replaceChildren e1 elts replaces all the children of e1 by elt.

see replaceChildren

replaceChildren e1 elts replaces all the children of e1 by elt.

replaceSelf elt1 elt2 replaces elt1 by elt2.

replaceSelf elt1 elt2 replaces elt1 by elt2.

retain v ~keep prevents keep from being garbage collected while v is live.

Same as retain but works with any object.

The function scrollIntoView elt scroll the page to a position where elt is displayed at the top of the window.

Creates a <select> tag.

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.

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

set_active_until_timeout c v sets the activity changing behaviour.

set_always_active c b if b is true, tells the client to always stay active.

Set the name of the HTML file loading our client app.

set_dom element custom_data value sets the custom data attribute for custom_data of an JavaScript element (Js_of_ocaml.Dom_html.element ) to value.

Makes possible to customize the function called when comet fails for unknown reason.

Makes possible to customize the function called when comet fails in Eliom_react, for example because a channel is full or closed.

To reduce traffic from the client busses try to send messages by group.

set_time_before_flush bus time set the maximum time to wait for a new message to enqueue before flushing.

after set_time_between_requests t v, the main loop will wait for v seconds between two requests.

set_time_between_requests_when_idle t (a, b, c) sets the time between two requests when the the windows does not have the focus, after the timeout.

set_timeout c t tells the client to stay active at least t seconds when the application lose the focus.

Not tracing by default.

retrieves a react signal for the status of the current page; note that the `current page' is not necessarily the page currently being displayed, but rather the page in whose context the current code is executed.

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.

Creates a <textarea> tag

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

transfer ~key ~src ~dst transfers the association between the value src and the value associated to key key to value dst.

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

unwrap_js v unwraps the content of the JavaScript variable v

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

Specifying parameter as user_type ~of_string ~to_string s tells that the service take a parameter, labeled s, and 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 external representation as a string.

Wait for the initialization phase to terminate

while_active initiates an action as onactive but cancels it whenever the page is not active anymore.

Loads an Eliom service in a window (cf.

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.

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

write b v send v to the bus b.