Ocsigen

Reference manual

Version dev

Index

Lwt

Eliom

Main modules

Pages with Ocamlduce

XHTML pages typed with variants

Other pages

Eliom_predefmod

Creating new kinds of pages

Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

Ocsigen - Reference manual

Ocsigen

Persistent data, writing in the logs, configuration file extension, Xhtml pretty printing, polymorphic tables

Ocsipersist	Persistent data on hard disk.
Ocsigen_messages	Writing messages in the logs
Ocsigen_parseconfig	Config file parsing
Simplexmlparser	Basic camlp4 parser for xml
Xhtmlpretty	XHTML pretty printing
Xhtmlcompact	XHTML "compact printing" (no pretty printing, no line breaks added)
Polytables	Polymorphic tables (using Map)
Ocsigen_cache	Cache.

Extending Ocsigen

Ocsigen_extensions	Writing extensions for Ocsigen
Ocsigen_headers	Getting informations from HTTP header.
Ocsigen_senders	Functions to create results for various kinds of documents
Ocsigen_http_frame	This table is to store cookie values for each path.
Ocsigen_http_client	Using Ocsigen as a HTTP client
Ocsigen_http_com	Sending and receiving HTTP frames
Ocsigen_stream	Streams are a means to read data block by block
Authbasic	Module `Authbasic`: Basic HTTP Authentication.

Eliom

Main modules

Eliom_services	This module allows to define services.
Eliom_parameters	This module defines the values used to declare the type of service parameters.
Eliom_sessions	This module contains the functions you need to get (or set) information about the request or the session.
Eliom_common	Low level functions for Eliom, exceptions and types.
Eliom_obrowser

Generating pages with OcamlDuce

Eliom_duce	A module to generate pages using OCamlduce
Xhtmltypes_duce	This interface corresponds to the XHTML 1.0 Strict DTD, for Ocamlduce.
Eliom_duce_tools

Generating pages typed with polymorphic variants

Eliom_predefmod.Xhtml	Eliom forms and service registration functions for XHTML
XHTML	Typesafe constructors for XHTML 1.1 documents.
Xhtmltypes	XHTML types with variants.
Eliom_tools	Predefined boxes for Eliom
Eliom_tools_common	Menus

Other kinds of pages

Eliom_predefmod

This modules contains predefined modules for generating forms and registering handlers, for several types of pages: XHTML pages typed with polymorphic variants, untyped (text) pages, actions, redirections, files ...

Creating your own kinds of pages

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.
Xhtmlpretty	XHTML pretty printing

Lwt

Lwt	Module `Lwt`: cooperative light-weight threads.
Lwt_util	Note: This lodule is deprecated.
Lwt_stream	Data streams
Lwt_sequence	Mutable sequence of elements
Lwt_monitor	Monitors
Lwt_mvar	Mailbox variables
Lwt_mutex	`locked mutex` returns whether `mutex` is currently locked
Lwt_event	Events utilities
Lwt_signal	Signals utilities
Lwt_pool	Creating pools (for example pools of connections to a database).
Lwt_throttle	Rate limiters
Lwt_timeout	set the default handler for exception occurring after a timeout.
Lwt_unix	Cooperative system calls
Lwt_gc	Interaction with the garbage collector
Lwt_io	Buffered byte channels
Lwt_process	Process management
Lwt_main	Main loop and event queue
Lwt_preemptive	This module allows to mix preemptive threads with `Lwt` cooperative threads.
Lwt_lib	Cooperative unix system calls
Lwt_ssl	Are we using an SSL socket?
Pa_lwt	Syntactic sugars for lwt

Indexes

Index of types
Index of exceptions
Index of values
Index of class methods
Index of classes
Index of modules
Index of module types