This is server API (go to client)

Index of modules


A
Action [Eliom_registration]

Eliom service registration for services that only execute actions.

Any [Eliom_registration]

Eliom service registration for services that choose dynamically what they want to send.

App [Eliom_registration]

Functor for application creation.

Atom_feed

Everything we need to make an atom feed.


C
C [Eliom_content.​Html]

Creation of HTML content from client-side values.

C [Eliom_content.​Svg]

Creation of content from client-side values.

Channel [Eliom_comet]

Basic primitives needed for server push.

Cookies [Eliom_cookie]

Map adressed by URL path, used for Eliom_cookie.​cookieset.

CssText [Eliom_registration]

Eliom service registration for services that returns CSS.

Custom_data [Eliom_content.​Html]

Type-safe custom data for HTML.

Customize [Eliom_registration]

The Customize functor allows specialization of service registration functions by customizing the page type.


D
D [Eliom_tools]

Menus with DOM semantics

D [Eliom_content.​Html]

Creation of HTML content with DOM semantics (referable, see also Eliom_content ).

D [Eliom_content.​Svg]

Typed interface for building valid SVG tree (DOM semantics).

Down [Eliom_react.​S]
Down [Eliom_react]

Event from server to client.


E
Eliom_atom

Register an atom feed

Eliom_bus

Broadcasting facilities between clients and server

Eliom_client

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

Eliom_client_value

Client and shared values

Eliom_comet

Primitives to push data to the client, without explicit request.

Eliom_common

Low level functions for Eliom, exceptions and types.

Eliom_config

This module makes also possible get information from the configuration file.

Eliom_content

This module allows creating valid HTML content, or other XML formats.

Eliom_content_sigs
Eliom_cookie

Cookies table manipulation (Duplicate of Ocsigen_cookies).

Eliom_cscache

Client-server cache for Eliom applications, that is used both for keeping data on client side or keeping values in memory during a request.

Eliom_extension

Allows Ocsigen's extension to access Eliom data.

Eliom_form_sigs

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

Eliom_lib

A few common functions used by Eliom.

Eliom_mkreg

This module defines the functor to use to creates modules generating functions to register services for your own types of pages.

Eliom_openid

OpenID identification

Eliom_parameter

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.

Eliom_parameter_sigs

Ad-hoc runtime type representation for service parameters.

Eliom_react

Propagate events occurrences from the server to the client and the other way around.

Eliom_reference

Server side state data, a.k.a Eliom references

Eliom_reg_sigs

Whether the service is capable to send application content when required.

Eliom_registration

Eliom services registration for various kinds of page content: Eliom application, valid Eliom_registration.​Html, actions, redirections, static files, …

Eliom_request_info

This module contains the functions you need to get (or set) information about current request.

Eliom_s2s

Server-to-Server communication module.

Eliom_service

Creation and manipulation of Eliom services.

Eliom_service_sigs

- 0-th param : method params 1-4 : GET and POST param types, param 5 : with/without suffix, param 6 : method for fallback service, param 7 : non-unit only for the Post (g, p) case when g != unit ; used to force unit GET parameters when needed

Eliom_shared

This module implements shared (i.e., client-server) versions of the React and ReactiveData libraries.

Eliom_shared_sigs

Accessing shared values

Eliom_state

Storing server-side values for your applications or sessions.

Eliom_syntax

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

Eliom_tmpl [Eliom_registration]
Eliom_tools

Helpers for (hierarchical) menu generation in HTML5.

Eliom_types

Types shared by client and server.

Eliom_uri

Low-level functions for relative or absolute URL calculation.

Eliom_wrap

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

Ext [Eliom_state]
Ext [Eliom_reference]

This module allows access to references for other groups, sessions, or client processes.

Ext [Eliom_reference.​Volatile]

F
F [Eliom_tools]

Menus with functional node semantics

F [Eliom_content.​Html]

Creation of Functional HTML5 content (copy-able but not referable, see also Eliom_content ).

F [Eliom_content.​Svg]

Typed interface for building valid SVG tree (functional semantics).

FakeReactiveData [Eliom_shared]

This is a dummy ReactiveData module that allows us to refer to client-side ReactiveData types on the server side, without actually linking against ReactiveData.

File [Eliom_registration]

Eliom service registration for services that returns file contents.

File_ct [Eliom_registration]

Same as file but makes possible to specify the content type for each file.

Flow5 [Eliom_registration]

Eliom service registration and forms creation for fragment of HTML5 page.

Form [Eliom_content_sigs.​LINKS_AND_FORMS]
Full_state_name_table [Eliom_common]

H
Html [Eliom_registration]

Eliom service registration for services that return HTML5 pages.

Html [Eliom_content]

Building and printing valid HTML5 tree.

Html_text [Eliom_registration]

Eliom service registration and forms creation for untyped HTML page.


I
Id [Eliom_content.​Html]

Node identifiers

Id [Eliom_content.​Svg]

Node identifiers.

Infix [Eliom_shared_sigs.​S]

Infix operators


L
Low_level [Eliom_state.​Ext]
Lwt [Eliom_shared_sigs.​RLIST]

Cooperative versions of the ReactiveData operators

Lwt [Eliom_shared_sigs.​S]

Cooperative versions of the React operators

Lwt_log [Eliom_lib]

M
Make [Eliom_openid]
Make [Eliom_mkreg]

Creates modules to register services for one type of pages

Make_poly [Eliom_mkreg]

Creating modules to register services for one type of parametrised pages

Make_typed_xml_registration [Eliom_registration]

Eliom service registration for services that returns fragment of TyXML's tree.


O
Ocaml [Eliom_registration]

Eliom service registration for services that send marshalled OCaml values.


P
Printer [Eliom_content.​Html]

"Polyglot" HTML printer.

Printer [Eliom_content.​Svg]

SVG printer.


R
R [Eliom_content.​Html]

Creation of HTML content from shared reactive signals and data (Eliom_shared ).

R [Eliom_content.​Svg]

Creation of SVG content from shared reactive signals and data (Eliom_shared ).

RList [Eliom_shared.​ReactiveData]
RList [Eliom_shared.​FakeReactiveData]
Raw [Eliom_content.​Html.​D]
Raw [Eliom_content.​Html.​F]
Raw [Eliom_content.​Svg.​R]
Raw [Eliom_content.​Svg.​D]
Raw [Eliom_content.​Svg.​F]
React [Eliom_shared]

Shared implementation of React

ReactiveData [Eliom_shared]

Shared implementation of ReactiveData

Redirection [Eliom_registration]

Eliom service registration for services that returns a redirections towards another service.

Reg [Eliom_atom]

S
S [Eliom_shared.​React]
S [Eliom_react]
Streamlist [Eliom_registration]

Eliom service registration for services that returns "byte" contents with Ocsigen's streams.

String [Eliom_registration]

Eliom service registration for services that returns "byte"-string contents.

String_redirection [Eliom_registration]

Eliom service registration for services that returns a redirections towards a string-URL.

Svg [Eliom_content]

Building and pretty-printing valid SVG tree.


U
Unit [Eliom_registration]

Similar to Actions with `NoReload option.

Up [Eliom_react]

Event from client to server.


V
Value [Eliom_shared]

Accessing shared values

Volatile [Eliom_reference]

Same functions as in Eliom_reference but a non-Lwt interface for non-persistent Eliom references.


X
Xml [Eliom_content]

Low-level XML manipulation.

Xml_shared [Eliom_content]