.TH "Eliom_common" 3o 2012-06-11 OCamldoc ""
.SH NAME
Eliom_common \- Low level functions for Eliom, exceptions and types.
.SH Module
Module   Eliom_common
.SH Documentation
.sp
Module
.BI "Eliom_common"
 : 
.B sig  end

.sp
Low level functions for Eliom, exceptions and types\&.
.sp

.sp

.sp
.sp

.I exception Eliom_404 

.sp
Page not found
.sp

.sp

.I exception Eliom_Wrong_parameter 

.sp
Service called with wrong parameter names
.sp

.sp

.I exception Eliom_Session_expired 

.sp

.sp

.I exception Eliom_Typing_Error 
.B of 
.B (string * exn) list

.sp
The service (GET or POST) parameters do not match expected type
.sp

.sp

.I exception Eliom_site_information_not_available 
.B of 
.B string

.sp
That function cannot be used when the site information is not available,
that is, outside a request or the initialisation phase of your Eliom module
(while reading the configuration file)\&.
.sp
In particular, you cannot use the function before the configuration file
is read for example when you are using static linking\&.
In that case you must
delay the function call using 
.B Eliom_service\&.register_eliom_module
\&.
.sp

.sp
.I type scope_name 
= 
.B Eliom_common_base.scope_name

.sp

.sp
.I type user_scope 
= 
.B [ `Client_process of scope_name
.B   | `Session of scope_name
.B   | `Session_group of scope_name ]

.sp

.sp
.I type scope 
= 
.B [ `Client_process of scope_name
.B   | `Session of scope_name
.B   | `Session_group of scope_name
.B   | `Site ]

.sp

.sp
.I type all_scope 
= 
.B [ `Client_process of scope_name
.B   | `Global
.B   | `Request
.B   | `Session of scope_name
.B   | `Session_group of scope_name
.B   | `Site ]

.sp

.sp
.I type global_scope 
= 
.B [ `Global ]

.sp

.sp
.I type site_scope 
= 
.B [ `Site ]

.sp

.sp
.I type session_group_scope 
= 
.B [ `Session_group of scope_name ]

.sp

.sp
.I type session_scope 
= 
.B [ `Session of scope_name ]

.sp

.sp
.I type client_process_scope 
= 
.B [ `Client_process of scope_name ]

.sp

.sp
.I type request_scope 
= 
.B [ `Request ]

.sp

.sp

.I val global 
: 
.B global_scope
.sp

.sp

.I val site 
: 
.B site_scope
.sp

.sp

.I val session_group 
: 
.B session_group_scope
.sp

.sp

.I val session 
: 
.B session_scope
.sp

.sp

.I val client_process 
: 
.B client_process_scope
.sp

.sp

.I val comet_client_process 
: 
.B client_process_scope
.sp

.sp

.I val request 
: 
.B request_scope
.sp

.sp

.I val create_scope_name 
: 
.B string -> scope_name
.sp

.sp

.I val list_scope_names 
: 
.B unit -> scope_name list
.sp

.sp
.I type cookie_scope 
= 
.B [ `Client_process | `Session ]

.sp
Eliom is using regular (browser) cookies but can also use
browser tab cookies (only if you are using a client side program)
.sp
It is possible to define data tables or service table for one
(browser) session, for one tab, or for one group of sessions\&.
.sp

.sp

.I val cookie_scope_of_user_scope 
: 
.B [< user_scope ] -> [> cookie_scope ]
.sp

.sp
.I type fullsessionname 
= 
.B cookie_scope * string

.sp

.sp
.I module Fullsessionname_Table : 
.B sig  end

.sp

.sp

.I val eliom_link_too_old 
: 
.B bool Polytables.key
.sp
If present and true in request data, it means that
the previous coservice does not exist any more
.sp

.sp

.I val eliom_service_session_expired 
: 
.B (fullsessionname list * fullsessionname list)
.B   Polytables.key
.sp
If present in request data,  means that
the service session cookies does not exist any more\&.
The string lists are the list of names of expired sessions
.sp

.sp