This is server API (go to client)

Index of types


A
a_attrib_t [Eliom_mkforms.​FORMS_PARAM]
a_attrib_t [Eliom_content.​Forms]
a_content_elt [Eliom_mkforms.​FORMS_PARAM]
a_content_elt [Eliom_content.​Forms]
a_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
a_content_elt_list [Eliom_content.​Forms]
a_elt [Eliom_mkforms.​FORMS_PARAM]
a_elt [Eliom_content.​Forms]
a_elt_list [Eliom_mkforms.​FORMS_PARAM]
a_s [Eliom_service]

The abstract type for attached service representation.

all_scope [Eliom_common]
answer [Eliom_comet_base]
appl [Eliom_registration.​ELIOM_APPL]

The type appl is an abstract type for identifying an application.

appl_service [Eliom_registration]

The type appl_service is used as a phantom type parameters for Eliom_service.​service and Eliom_registration.​kind.

appl_service [Eliom_service]
appl_service_options [Eliom_registration]

Type for the options of an Eliom application service.

application_content [Eliom_registration]

The type application_content is a refinement of Eliom_registration.​appl_service to be used as a phantom type parameters for Eliom_registration.​kind.

attached [Eliom_service]

Restriction of service_kind to attached services.

attached_service_kind [Eliom_service]

An attached service could either be an `Internal Eliom service or an abstraction for an `External service.

attrib [Eliom_content.​Html5]
attrib [Eliom_content_core.​Html5]
attrib [Eliom_content_core.​Svg]
authentication_result [Eliom_openid]

The result of an authentication.

author [Atom_feed]

B
base [Atom_feed]
binsum [Eliom_parameter]

Helpers type used for parameters of type binary sum, see Eliom_parameter.​sum.

block_content [Eliom_registration]

The type block_content is a refinement of Eliom_registration.​http_service to be used as a phantom type parameters for Eliom_registration.​kind.

browser_content [Eliom_registration]

The type browser_content is a refinement of Eliom_registration.​http_service to be used as a phantom type parameters for Eliom_registration.​kind.

bus_send_service [Eliom_comet_base]
button_attrib_t [Eliom_mkforms.​FORMS_PARAM]
button_attrib_t [Eliom_content.​Forms]
button_content_elt [Eliom_mkforms.​FORMS_PARAM]
button_content_elt [Eliom_content.​Forms]
button_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
button_content_elt_list [Eliom_content.​Forms]
button_elt [Eliom_mkforms.​FORMS_PARAM]
button_elt [Eliom_content.​Forms]
button_type_t [Eliom_mkforms.​FORMS_PARAM]
button_type_t [Eliom_content.​Forms]

C
caml_event_handler [Eliom_content_core.​Xml]

Values of type 'a caml_event_handler represents event handler build with the {{ ... }} syntax (see the Eliom manual for more information on syntax extension).

category [Atom_feed]
chan_id [Eliom_comet_base]
channel_data [Eliom_comet_base]
check_fun [Eliom_openid]

The type of the authenticate function.

client_process_scope [Eliom_common]
client_value [Eliom_pervasives]

Client values on the server are created by the syntax {typ{ expr }} in the server section (cf.

client_value [Eliom_lib]
comet_request [Eliom_comet_base]
comet_scope [Eliom_comet.​Channel]
comet_service [Eliom_comet_base]
comet_stateful_request [Eliom_comet_base]
comet_stateless_request [Eliom_comet_base]

None means 'newest channel'

command [Eliom_comet_base]
content [Atom_feed]
contributor [Atom_feed]
cookie [Eliom_cookie]

HTTP cookies representation.

cookie_level [Eliom_common]
cookie_scope [Eliom_common]
cookieset [Eliom_cookie]

Set of cookie, grouped by path.

coordinates [Eliom_parameter]

The type coordinates represent the data sent by an <input type="image" ...>.


D
data_cookie_info [Eliom_state.​Ext]
dateConstruct [Atom_feed]

E
eliom_extension_sig [Eliom_extension]

Type of the function that must be registered to declare an eliom extension.

elt [Eliom_content.​Html5]

See the Eliom manual for more information on dom semantics vs. functional semantics for HTML5 tree manipulated by client/server application.

elt [Eliom_content_core.​Html5]

See the Eliom manual for more information on dom semantics vs. functional semantics for HTML5 tree manipulated by client/server application.

elt [Eliom_content_core.​Svg]

See the Eliom manual for more information ondom semantics vs. functional semantics for SVG tree manipulated by client/server application.

emailAddress [Atom_feed]
entry [Atom_feed]
entryOAttr [Atom_feed]

Children tags allowed for the entry tag

eref [Eliom_reference.​Volatile]

The type of volatile Eliom references.

eref [Eliom_reference]

The type of Eliom references whose content is of type 'a.

eref' [Eliom_reference]

Eliom references come in two flavors: they may be stored persistently or the may be volatile.

extension [Eliom_openid]

An extension yielding values of type 'a


F
feed [Eliom_atom]

Needed when used with Pubsubhubbub

feed [Atom_feed]
feedOAttr [Atom_feed]

Children tags allowed for the feed tag

field [Eliom_openid]

A field you can request to the provider

file_info [Eliom_lib]
for_attrib [Eliom_mkforms.​FORMS_PARAM]
for_attrib [Eliom_content.​Forms]
form_attrib_t [Eliom_mkforms.​FORMS_PARAM]
form_attrib_t [Eliom_content.​Forms]
form_content_elt [Eliom_mkforms.​FORMS_PARAM]
form_content_elt [Eliom_content.​Forms]
form_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
form_content_elt_list [Eliom_content.​Forms]
form_elt [Eliom_mkforms.​FORMS_PARAM]
form_elt [Eliom_content.​Forms]
full_state_name [Eliom_common]

G
generator [Atom_feed]
get_page [Eliom_tools]

Restriction of Eliom_service.​service to registrable GET services without parameters that do not returns a marshalled OCaml value.

get_page [Eliom_tools_common]
get_service_kind [Eliom_service]

Restriction of service_kind to services without POST parameters.

getpost [Eliom_service]

The kind of a service is `Post when there is at least one POST parameters.

global_scope [Eliom_common]

Eliom is using regular (browser) cookies but can also use its own browser tab cookies (only if you are using a client side Eliom application).


H
hierarchical_site [Eliom_tools]

Hierarchical sites description.

hierarchical_site [Eliom_tools_common]
hierarchical_site_item [Eliom_tools]
hierarchical_site_item [Eliom_tools_common]

Hierchical sites

href [Atom_feed]
hrefLang [Atom_feed]
http_service [Eliom_registration]

The type http_service is used as a phantom type parameters for Eliom_service.​service and Eliom_registration.​kind.

http_service [Eliom_service]

Types of groups of services.


I
icon [Atom_feed]
id [Atom_feed]
id [Eliom_content_core.​Html5.​Id]

The type of global HTML5 element identifier.

id [Eliom_content_core.​Svg.​Id]

The type of global SVG element identifier.

input_attrib_t [Eliom_mkforms.​FORMS_PARAM]
input_attrib_t [Eliom_content.​Forms]
input_elt [Eliom_mkforms.​FORMS_PARAM]
input_elt [Eliom_content.​Forms]
input_type_t [Eliom_mkforms.​FORMS_PARAM]
input_type_t [Eliom_content.​Forms]
internal_comet_service [Eliom_comet_base]
internal_service_kind [Eliom_service]

Restriction of service_kind to internal services.


K
kind [Eliom_registration]

The type kind is an abstract type for the HTTP frame returned by a service.


L
label [Atom_feed]
lang [Atom_feed]
length [Atom_feed]
link [Atom_feed]
linkOAttr [Atom_feed]

Children tags allowed for the link tag

link_attrib_t [Eliom_mkforms.​FORMS_PARAM]
link_attrib_t [Eliom_content.​Forms]
link_elt [Eliom_mkforms.​FORMS_PARAM]
link_elt [Eliom_content.​Forms]
listnames [Eliom_parameter]

Helpers type used to construct forms from lists, see Eliom_parameter.​list.

logo [Atom_feed]
ltitle [Atom_feed]

M
main_page [Eliom_tools]

Main page description for a section of a hierarchical site.

main_page [Eliom_tools_common]
mediaType [Atom_feed]
metaAttr [Atom_feed]

Common optional attributes


N
na_s [Eliom_service]

The abstract type for non-attached service representation.

ncname [Atom_feed]
nl_params_set [Eliom_parameter]

Use this type to give non localized parameters to a link or a form

no_param_name [Eliom_parameter]

Empty type used to denotes it is not possible to use the parameter in a form.

non_localized_params [Eliom_parameter]

Non localized parameters

non_ocaml_service [Eliom_registration]

The type non_ocaml_service is used as phantom type parameters for the Eliom_registration.​kind.

non_ocaml_service [Eliom_service]

The type non_ocaml_service is used as phantom type parameters for the Eliom_registration.​kind.

nonattached [Eliom_service]

Restriction of service_kind to non-attached services.


O
ocaml [Eliom_parameter]

marshaled OCaml values of type 'a

ocaml_content [Eliom_registration]

The type ocaml_content is an synomyn for Eliom_service.​ocaml_service to be used as a phantom type parameters for Eliom_registration.​kind.

ocaml_service [Eliom_service]
one_page [Eliom_tools]

Restriction of Eliom_service.​service to services without parameters that do not returns a marshalled OCaml value.

one_page [Eliom_tools_common]

Menus

oneradio [Eliom_parameter]

Restriction of Eliom_parameter.​setoneradio unary and optional parameters.

openid_error [Eliom_openid]

Error that may happen when identifiying an user

optgroup_attrib_t [Eliom_mkforms.​FORMS_PARAM]
optgroup_attrib_t [Eliom_content.​Forms]
option_attrib_t [Eliom_mkforms.​FORMS_PARAM]
option_attrib_t [Eliom_content.​Forms]
option_elt [Eliom_mkforms.​FORMS_PARAM]
option_elt_list [Eliom_mkforms.​FORMS_PARAM]
options [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
options [Eliom_mkreg.​REG_PARAM]
options [Eliom_mkreg.​MakeRegister_AlphaReturn]
options [Eliom_registration.​Registration]
options [Eliom_registration.​Any]
options [Eliom_registration.​Redirection]

P
page [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
page [Eliom_mkreg.​REG_PARAM]
page [Eliom_mkreg.​MakeRegister_AlphaReturn]
page [Eliom_registration.​Registration]
page [Eliom_registration.​Any]
page [Eliom_registration.​Redirection]
pape [Eliom_openid]

The pape data returned by the server

param_name [Eliom_parameter]

Abstract type for parameters' name.

params_type [Eliom_parameter]

Abstract type for service parameters.

pcdata_elt [Eliom_mkforms.​FORMS_PARAM]
pcdata_elt [Eliom_content.​Forms]
persistent_cookie_info [Eliom_state.​Ext]
persistent_table [Eliom_state]

The type of persistent state data tables.

personConstruct [Atom_feed]

Children tags allowed for the author and contributor tags

position [Eliom_comet_base]
post_service_kind [Eliom_service]

Restriction of service_kind to services with at least one POST parameters.

published [Atom_feed]

R
registrable [Eliom_service]

A service is `Registrable only if it isn't a pre-applied service, see Eliom_service.​preapply.

rel [Atom_feed]
request_scope [Eliom_common]
result [Eliom_openid]

The result yielded by the authentication process

result [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
result [Eliom_mkreg.​REG_PARAM]
result [Eliom_mkreg.​MakeRegister_AlphaReturn]
result [Eliom_registration.​Registration]
result [Eliom_registration.​Any]
result [Eliom_registration.​Redirection]
return [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
return [Eliom_mkreg.​REG_PARAM]
return [Eliom_mkreg.​MakeRegister_AlphaReturn]
return [Eliom_registration.​Registration]
return [Eliom_registration.​Any]
return [Eliom_registration.​Redirection]
rt [Eliom_service]

Helper for typing ocaml services


S
scheme [Atom_feed]
scope [Eliom_common]
scope_hierarchy [Eliom_common]

Scopes

script_attrib_t [Eliom_mkforms.​FORMS_PARAM]
script_attrib_t [Eliom_content.​Forms]
script_elt [Eliom_mkforms.​FORMS_PARAM]
script_elt [Eliom_content.​Forms]
select_attrib_t [Eliom_mkforms.​FORMS_PARAM]
select_attrib_t [Eliom_content.​Forms]
select_content_elt [Eliom_mkforms.​FORMS_PARAM]
select_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
select_elt [Eliom_mkforms.​FORMS_PARAM]
select_elt [Eliom_content.​Forms]
select_opt [Eliom_mkforms.​MakeForms]

The type for <select> options and groups of options.

select_opt [Eliom_content.​Forms]

The type for <select> options and groups of options.

select_opt [Eliom_content.​Html_text]

The type for <select> options and groups of options.

select_opt [Eliom_content.​Html5.​D]

The type for <select> options and groups of options.

select_opt [Eliom_content.​Html5.​F]

The type for <select> options and groups of options.

servcoserv [Eliom_service]

An internal attached service could either be a `Service or a `Coservice.

server_function [Eliom_pervasives]

A value of type ('a, 'b) server_function is created on the server from a function 'a -> 'b Lwt.t and provides a given function on the client side.

server_params [Eliom_types_base]
server_params [Eliom_types]
service [Eliom_service]

Type of services.

service_cookie_info [Eliom_state.​Ext]

These types are used to get or set information about browser or process cookies (like timeouts).

service_kind [Eliom_service]

The type service_kind describe all four kind of services: external (attached) services, (internal) attached services, (internal) attached coservices, (internal) non-attached coservices

session_group_scope [Eliom_common]
session_scope [Eliom_common]
setone [Eliom_parameter]

Restriction of Eliom_parameter.​setoneradio unary and set parameters.

setoneradio [Eliom_parameter]

A parameter arity could either be: `Set of 'a means: any number of 'a., `One of 'a means: exactly one 'a., `Radio of 'a means: zero or one 'a.

site_scope [Eliom_common]
sitedata [Eliom_types_base]
sitedata [Eliom_types]
soption [Eliom_mkforms.​MakeForms]
soption [Eliom_content.​Forms]
soption [Eliom_content.​Html_text]
soption [Eliom_content.​Html5.​D]
soption [Eliom_content.​Html5.​F]
source [Atom_feed]
sourceOAttr [Atom_feed]

Children tags allowed for the source tag

state [Eliom_state.​Ext]

The type of states.

state_status [Eliom_state]

The following functions return the current state of the state for a given scope: Alive_state means that data has been recorded for this scope, Empty_state means that there is no data for this scope, Expired_state means that data for this scope has been removed because the timeout has been reached. The default scope is `Session.

stateless_kind [Eliom_comet_base]
suff [Eliom_service]

The kind of parameters for a service is `WithSuffix when it have a suffix parameter, for examples Eliom_parameter.​suffix or Eliom_parameter.​suffix_prod.

suff [Eliom_parameter]

This type is used as a phantom type in Eliom_parameter.​params_type to describe whether a parameter is encoded in the path of the URI as a suffix parameter.


T
t [Eliom_bus]

The type of bus's carrying values of type 'a.

t [Eliom_react.​S.​Down]

The abstract type of down signals.

t [Eliom_react.​Up]

The type of events that, while being "on the server", are triggered by clients.

t [Eliom_react.​Down]

The abstract type of down events.

t [Eliom_comet.​Channel]

v t is the type of server-to-client communication channels transporting data of type v

t [Eliom_registration.​TMPL_PARAMS]
t [Eliom_content_core.​Html5.​Custom_data]

Custom data with values of type 'a.

term [Atom_feed]
textConstruct [Atom_feed]
textarea_attrib_t [Eliom_mkforms.​FORMS_PARAM]
textarea_attrib_t [Eliom_content.​Forms]
textarea_elt [Eliom_mkforms.​FORMS_PARAM]
textarea_elt [Eliom_content.​Forms]
timeout [Eliom_state.​Ext]

Type used to describe session timeouts


U
unknown_content [Eliom_registration]

The type unknown_content is a refinement of Eliom_registration.​http_service to be used as a phantom type parameters for Eliom_registration.​kind when the content-type can't be determined staticaly.

unwrap_id [Eliom_wrap]

unwrap *

unwrapper [Eliom_wrap]
updated [Atom_feed]
uri [Atom_feed]
uri [Eliom_mkforms.​FORMS_PARAM]
uri [Eliom_mkforms.​MakeForms]
uri [Eliom_content.​Forms]
uri [Eliom_content.​Html5]
uri [Eliom_content_core.​Html5]
uri [Eliom_content_core.​Svg]
user_level [Eliom_common]
user_scope [Eliom_common]

V
volatile_table [Eliom_state]

The type of (volatile) state data tables.


W
wrap [Eliom_content_core.​Html5]
wrap [Eliom_content_core.​Svg]
wrapped_bus [Eliom_comet_base]
wrapped_channel [Eliom_comet_base]
wrapped_value [Eliom_wrap]
wrapper [Eliom_wrap]

'a wrapper is the type of values to include into a value of type 'a for it to be wraped specificaly