This is server API (go to client)

Warning: Reason support is experimental. We are looking for beta-tester and contributors.

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.


B
Block [Eliom_registration]

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

Block5 [Eliom_registration]

Deprecated alias for Eliom_registration.​Flow5.


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

Customize [Eliom_registration]

The Customize functor allows to specialize service registration functions by customizing the page type.


D
D [Eliom_content.​Html5]

Creation of HTML5 content with DOM semantics (referable, cf.

D [Eliom_content_core.​Html5]

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

D [Eliom_content_core.​Svg]

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

Down [Eliom_react.​S]
Down [Eliom_react]

A "Down event" (AKA down-going event) is an event which occurrences are transmitted asynchronously to the client.


E
Eliom_atom

Register an atom feed

Eliom_bus

Broadcasting facilities between clients and server

Eliom_comet

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

Eliom_comet_base

None means 'newest channel'

Eliom_common

Low level functions for Eliom, exceptions and types.

Eliom_config

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

Eliom_content

This module provides the creation of valid XML content, i.e.

Eliom_content_core

See Eliom_content for complete module.

Eliom_cookie

Cookies table manipulation (Duplicate of Ocsigen_cookies).

Eliom_extension

Allows Ocsigen's extension to access Eliom data.

Eliom_lib

Pervasives module for Eliom-server: it extends the OCaml stdlib and should always be opened.

Eliom_mkforms

This module defines the functor to use to creates modules generating form widgets for your own types of pages.

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

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_registration

Eliom services registration for various kinds of page content: Eliom application, valid Eliom_registration.​Html5 or Eliom_registration.​Xhtml, 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_state

Manage server-side state.

Eliom_tmpl [Eliom_registration]
Eliom_tools

Helpers for (hierarchical) menu generation in HTML5 and XHTML.

Eliom_tools_common

Menus

Eliom_types

Types shared by client and server.

Eliom_types_base

/*

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


F
F [Eliom_content.​Xhtml]

Creation of functional HTML5 content (copy-able but not referable).

F [Eliom_content.​Html5]

Creation of functional HTML5 content (copy-able but not referable, cf.

F [Eliom_content_core.​Xhtml]

Typed interface for building valid XHTML (Strict) tree.

F [Eliom_content_core.​Html5]

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

F [Eliom_content_core.​Svg]

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

F_01_00 [Eliom_content.​Xhtml]
F_01_00 [Eliom_content_core.​Xhtml]

Typed interface for building valid XHTML (1.0 Strict) tree.

F_01_01 [Eliom_content.​Xhtml]
F_01_01 [Eliom_content_core.​Xhtml]

Typed interface for building valid XHTML (1.1 Strict) tree.

File [Eliom_registration]

Eliom service registration for services that returns file contents.

Flow5 [Eliom_registration]

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

Fullsessionname_Table [Eliom_common]

H
Html5 [Eliom_tools]
Html5 [Eliom_registration]

Eliom service registration for HTML5 page.

Html5 [Eliom_content]

Building and printing valid (X)HTML5 tree.

Html5 [Eliom_content_core]

Building and printing valid (X)HTML5 tree.

Html5_registration [Eliom_registration]

Eliom service registration for services that returns HTML5 page.

Html_text [Eliom_registration]

Eliom service registration and forms creation for untyped HTML page.

Html_text [Eliom_content]

I
Id [Eliom_content.​Html5]

Node identifiers

Id [Eliom_content_core.​Html5]

Node identifiers

Id [Eliom_content_core.​Svg]

Node identifiers.


J
Json_answer [Eliom_comet_base]
Json_channel_data [Eliom_comet_base]
Json_comet_request [Eliom_comet_base]
Json_comet_stateful_request [Eliom_comet_base]
Json_comet_stateless_request [Eliom_comet_base]
Json_command [Eliom_comet_base]
Json_position [Eliom_comet_base]

M
Make [Eliom_openid]

This functor build a hidden service that will be used to receive the remote server's data.

MakeForms [Eliom_mkforms]
MakeRegister [Eliom_mkreg]
MakeRegister_AlphaReturn [Eliom_mkreg]
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 caml values.


P
Printer [Eliom_content.​Xhtml]
Printer [Eliom_content.​Html5]
Printer [Eliom_content_core.​Xhtml]

XHTML (latest Strict) printer.

Printer [Eliom_content_core.​Html5]

"Polyglot" HTML5 printer.

Printer [Eliom_content_core.​Svg]

SVG printer.

Printer_01_00 [Eliom_content.​Xhtml]
Printer_01_00 [Eliom_content_core.​Xhtml]

XHTML (1.0 Strict) printer.

Printer_01_01 [Eliom_content.​Xhtml]
Printer_01_01 [Eliom_content_core.​Xhtml]

XHTML (1.1 Strict) printer.


R
Raw [Eliom_content_core.​Xhtml.​F_01_01]
Raw [Eliom_content_core.​Xhtml.​F_01_00]
Raw [Eliom_content_core.​Xhtml.​F]
Raw [Eliom_content_core.​Html5.​D]

Cf.

Raw [Eliom_content_core.​Html5.​F]

Cf.

Redirection [Eliom_registration]

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

Reg [Eliom_atom]

S
S [Eliom_react]
Session_admin [Eliom_state]
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.

Svg [Eliom_content_core]

Building and pretty-printing valid SVG tree.


T
Text [Eliom_registration]

Deprecated alias for Eliom_registration.​String.


U
Unit [Eliom_registration]

Similar to Actions with `NoReload option.

Up [Eliom_react]

Up events are quite different from Down events.


V
Volatile [Eliom_reference]

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


X
Xhtml [Eliom_tools]

Menu and hierarchical site for XHTML

Xhtml [Eliom_registration]

Eliom service registration for XHTML page.

Xhtml [Eliom_content]

Building valid XHTML.

Xhtml [Eliom_content_core]

Building and printing valid XHTML tree.

Xhtml_registration [Eliom_registration]

Eliom service registration for services that returns XHTML page.

Xml [Eliom_content]

Low-level XML manipulation.

Xml [Eliom_content_core]

Low-level XML manipulation.