This is server API (go to client)

Index of values


( ** ) [Eliom_parameter_sigs.​S]

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

(=|<) [Eliom_shared_sigs.​S.​Infix]

f =|< s is map f s.

(>|=) [Eliom_shared_sigs.​S.​Infix]

s >|= f is map f s.


A
a [Eliom_form_sigs.​LINKS]

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.

acc_e [Eliom_shared_sigs.​RLIST]
add_cookie [Eliom_cookie]

The function add_cookie path c v cookie_table adds the cookie c to the table cookie_table.

add_cookies [Eliom_cookie]

The functionadd_cookies newcookies oldcookies adds the cookies from newcookies to oldcookies.

add_nl_parameter [Eliom_parameter_sigs.​S]
add_non_localized_get_parameters [Eliom_service_sigs.​S]

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

add_non_localized_post_parameters [Eliom_service_sigs.​S]
all_suffix [Eliom_parameter_sigs.​S]

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

all_suffix_regexp [Eliom_parameter]

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.

all_suffix_string [Eliom_parameter_sigs.​S]

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

all_suffix_user [Eliom_parameter]

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

any [Eliom_parameter_sigs.​S]

Use this if you want to take any parameters.

appl_self_redirect [Eliom_registration]

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

application_name [Eliom_registration.​APP]

Unique identifier for this application.

application_name [Eliom_registration_sigs.​APP_PARAM]

Name of the application.

application_script [Eliom_registration.​APP]

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

attach [Eliom_service]

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

attr [Eliom_content.​Html.​C]
attr [Eliom_content.​Svg.​C]
attrib [Eliom_content.​Html.​Custom_data]

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 (Eliom_content.​Html.​elt ).


B
bool [Eliom_parameter_sigs.​S]

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

bool [Eliom_form_sigs.​S]
bool_checkbox_one [Eliom_form_sigs.​S]

Creates a checkbox <input> tag of type bool.

button [Eliom_form_sigs.​S]

Creates a <button> tag.

button_no_value [Eliom_form_sigs.​S]

Creates a <button> tag with no value.


C
cast_http_result [Eliom_registration]

cast_http_result should only be used to register new output modules

cast_unknown_content_kind [Eliom_registration]

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.

check_file [Eliom_registration.​File_ct]

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

check_file [Eliom_registration.​File]

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

checkbox [Eliom_form_sigs.​S]

Creates a checkbox <input> tag.

clean [Eliom_notif.​S]

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

clean_request_cache [Eliom_request_info]

Remove all data from the request cache

client [Eliom_shared_sigs.​VALUE]

client x is the client-side portion of x.

client_ev [Eliom_notif.​S]

Returns the client react event.

client_value [Eliom_syntax]

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

close_client_section [Eliom_syntax]

Called at the end of every client or shared section.

close_server_section [Eliom_syntax]

Called at the end of each server or shared section.

comet_client_process_scope [Eliom_common]
concat [Eliom_shared_sigs.​RLIST]
const [Eliom_shared_sigs.​S]
cookie_level_of_user_scope [Eliom_common]
cookie_scope_of_user_scope [Eliom_common]
coordinates [Eliom_parameter_sigs.​S]

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

create [Eliom_service]

Service definition

create [Eliom_cscache]

Create a new table.

create [Eliom_shared.​React.​S]

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 [Eliom_react.​Up]

create param creates an Up event.

create [Eliom_content.​Html.​Custom_data]

Create a custom data field by providing string conversion functions.

create [Eliom_comet.​Channel]

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

create [Eliom_bus]

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

create [Eliom_shared_sigs.​RLIST]

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.

create [Eliom_shared_sigs.​VALUE]
create [Eliom_registration_sigs.​S_poly_with_create]
create [Eliom_registration_sigs.​S_with_create]

Create a service and register it at the same time.

create_attached_get [Eliom_service]

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

create_attached_get [Eliom_registration_sigs.​S_poly_with_create]
create_attached_get [Eliom_registration_sigs.​S_with_create]

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

create_attached_post [Eliom_service]

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

create_attached_post [Eliom_registration_sigs.​S_poly_with_create]
create_attached_post [Eliom_registration_sigs.​S_with_create]

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

create_filtered [Eliom_bus]

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

create_global_elt [Eliom_content.​Html.​Id]

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

create_global_elt [Eliom_content.​Svg.​Id]

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

create_json [Eliom_content.​Html.​Custom_data]

Create a custom data from a Json-deriving type.

create_named_elt [Eliom_content.​Html.​Id]

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

create_named_elt [Eliom_content.​Svg.​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 [Eliom_comet.​Channel]

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 [Eliom_content.​Html.​Id]

create_request_elt ?reset elt creates a referable copy of elt.

create_request_elt [Eliom_content.​Svg.​Id]

create_request_elt ?reset elt creates a referable copy of elt.

create_scope_hierarchy [Eliom_common]
create_unlimited [Eliom_comet.​Channel]

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

create_wrapper [Eliom_wrap]

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

css_link [Eliom_form_sigs.​LINKS]

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

current_persistent_session_state [Eliom_state.​Ext]

Same for persistent data

current_service_session_state [Eliom_state.​Ext]

Same for services

current_volatile_session_state [Eliom_state.​Ext]

current_volatile_session_state ~scope returns the state corresponding to current session in scope scope.


D
debug [Eliom_lib]

Deprecated.

default_appl_service_options [Eliom_registration]

The default options record for an eliom service.

default_group_scope [Eliom_common]
default_process_scope [Eliom_common]
default_protocol_is_https [Eliom_config]

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

default_session_scope [Eliom_common]
deinit [Eliom_notif.​S]

Deinitialise/deactivate the notification module for the current client.

discard [Eliom_state]

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 [Eliom_state]

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

discard_all_data [Eliom_state]

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

discard_all_scopes [Eliom_state]
discard_all_services [Eliom_state]

Remove all services registered for clients for the given scope.

discard_data [Eliom_state]

Remove current state data.

discard_everything [Eliom_state]

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

discard_services [Eliom_state]

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

discard_state [Eliom_state.​Ext]

Discard external states

do_cache [Eliom_cscache]

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


E
eliom [Eliom_lib.​Lwt_log]
eliom_link_too_old [Eliom_common]

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

eliom_service_session_expired [Eliom_common]

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

empty_cookieset [Eliom_cookie]

Empty set of cookies.

empty_nl_params_set [