This is server API (go to client)

Module Eliom_registration.​Any

module Any : sig..end

Eliom service registration for services that choose dynamically what they want to send. The content is created using for example Eliom_registration.​Html5.​send or Eliom_registration.​String.​send functions. See the Eliom manual for more information about services that choose dynamically what they want to send


type ('a, 'b) page = ('a, 'b) Eliom_registration.kind
type options = unit
type 'a return = 'a
type ('a, 'b) result = ('a, 'b) Eliom_registration.kind

Service registration

val register : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  service:('a, 'b, [< Eliom_service.internal_service_kind ],
   [< Eliom_service.suff ], 'c, 'd, [ `Registrable ], 'e)
   Eliom_service.service ->
  ?error_handler:((string * exn) list ->
   ('f, 'e) Eliom_registration.kind Lwt.t) ->
  ('a -> 'b -> ('f, 'e) Eliom_registration.kind Lwt.t) -> unit

The function register service handler will associate the service to the function handler. The handler function take two parameters, the GET and POST parameters of the current HTTP request, and should returns the corresponding page.

The optional parameter ~scope is Eliom_common.global by default, see the Eliom manual for detailled description of different scope.

The optional parameter ~options is specific to each output module, see the type description for more information.

The optional parameters ?charset, ?code, ?content_type and ?headers can be used to modify the HTTP answer sent by Eliom. Use this with care.

The optional parameter ~secure_session has no effect for scope Eliom_common.global. With other scopes, the parameter is used to force the session service table in which the handler will be registered. By default, the service is registred in the unsecure session if the current request's protocol is http, or in the secure session if the protocol is https. If set to false (resp. true) the handler will be stored in the unsecure (resp. secure) session. See the Eliom manual for an introduction to secure state.

The optional parameter ~error_handler is used to specialize the error page when actual parameters aren't compatible with the expected type. The default error handler is fun l -> raise (Eliom_common.​Eliom_Typing_Errorl).

val register_service : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?https:bool ->
  ?priority:int ->
  path:Eliom_lib.Url.path ->
  get_params:('a, [< Eliom_service.suff ] as 'b, 'c)
   Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('d, 'e) Eliom_registration.kind Lwt.t) ->
  ('a -> unit -> ('d, 'e) Eliom_registration.kind Lwt.t) ->
  ('a, unit,
   [> `Attached of
   ([> `Internal of [> `Service ] ], [> `Get ]) Eliom_service.a_s ],
   'b, 'c, unit, [< Eliom_service.registrable > `Registrable ], 'e)
  Eliom_service.service
val register_coservice : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?name:string ->
  ?csrf_safe:bool ->
  ?csrf_scope:[< Eliom_common.user_scope ] ->
  ?csrf_secure:bool ->
  ?max_use:int ->
  ?timeout:float ->
  ?https:bool ->
  fallback:(unit, unit,
   [ `Attached of
   ([ `Internal of [ `Service ] ], [ `Get ])
   Eliom_service.a_s ],
   [ `WithoutSuffix ], unit, unit,
   [< Eliom_service.registrable ], 'a)
   Eliom_service.service ->
  get_params:('b, [ `WithoutSuffix ], 'c) Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('d, 'a) Eliom_registration.kind Lwt.t) ->
  ('b -> unit -> ('d, 'a) Eliom_registration.kind Lwt.t) ->
  ('b, unit,
   [> `Attached of
   ([> `Internal of [> `Coservice ] ], [> `Get ]) Eliom_service.a_s ],
   [ `WithoutSuffix ], 'c, unit,
   [< Eliom_service.registrable > `Registrable ], 'a)
  Eliom_service.service
val register_coservice' : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?name:string ->
  ?csrf_safe:bool ->
  ?csrf_scope:[< Eliom_common.user_scope ] ->
  ?csrf_secure:bool ->
  ?max_use:int ->
  ?timeout:float ->
  ?https:bool ->
  get_params:('a, [ `WithoutSuffix ], 'b) Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('c, 'd) Eliom_registration.kind Lwt.t) ->
  ('a -> unit -> ('c, 'd) Eliom_registration.kind Lwt.t) ->
  ('a, unit, [> `Nonattached of [> `Get ] Eliom_service.na_s ],
   [ `WithoutSuffix ], 'b, unit,
   [< Eliom_service.registrable > `Registrable ], 'd)
  Eliom_service.service
val register_post_service : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?https:bool ->
  ?priority:int ->
  fallback:('a, unit,
   [ `Attached of
   ([ `Internal of [ `Coservice | `Service ] ], [ `Get ])
   Eliom_service.a_s ],
   [< Eliom_service.suff ] as 'b, 'c, unit, [<
   `Registrable ], 'd)
   Eliom_service.service ->
  post_params:('e, [ `WithoutSuffix ], 'f) Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('g, 'h) Eliom_registration.kind Lwt.t) ->
  ('a -> 'e -> ('g, 'h) Eliom_registration.kind Lwt.t) ->
  ('a, 'e,
   [> `Attached of
   ([> `Internal of [ `Coservice | `Service ] ], [> `Post ])
   Eliom_service.a_s ],
   'b, 'c, 'f, [< Eliom_service.registrable > `Registrable ], 'h)
  Eliom_service.service
val register_post_coservice : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?name:string ->
  ?csrf_safe:bool ->
  ?csrf_scope:[< Eliom_common.user_scope ] ->
  ?csrf_secure:bool ->
  ?max_use:int ->
  ?timeout:float ->
  ?https:bool ->
  fallback:('a, unit,
   [ `Attached of
   ([ `Internal of [< `Coservice | `Service ] ], [ `Get ])
   Eliom_service.a_s ],
   [< Eliom_service.suff ] as 'b, 'c, unit, [<
   `Registrable ], 'd)
   Eliom_service.service ->
  post_params:('e, [ `WithoutSuffix ], 'f) Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('g, 'd) Eliom_registration.kind Lwt.t) ->
  ('a -> 'e -> ('g, 'd) Eliom_registration.kind Lwt.t) ->
  ('a, 'e,
   [> `Attached of
   ([> `Internal of [> `Coservice ] ], [> `Post ])
   Eliom_service.a_s ],
   'b, 'c, 'f, [< Eliom_service.registrable > `Registrable ], 'd)
  Eliom_service.service
val register_post_coservice' : 
  ?scope:[< Eliom_common.scope ] ->
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ?secure_session:bool ->
  ?name:string ->
  ?csrf_safe:bool ->
  ?csrf_scope:[< Eliom_common.user_scope ] ->
  ?csrf_secure:bool ->
  ?max_use:int ->
  ?timeout:float ->
  ?keep_get_na_params:bool ->
  ?https:bool ->
  post_params:('a, [ `WithoutSuffix ], 'b) Eliom_parameter.params_type ->
  ?error_handler:((string * exn) list ->
   ('c, 'd) Eliom_registration.kind Lwt.t) ->
  (unit -> 'a -> ('c, 'd) Eliom_registration.kind Lwt.t) ->
  (unit, 'a, [> `Nonattached of [> `Post ] Eliom_service.na_s ],
   [ `WithoutSuffix ], unit, 'b,
   [< Eliom_service.registrable > `Registrable ], 'd)
  Eliom_service.service

Low-level function

val send : 
  ?options:unit ->
  ?charset:string ->
  ?code:int ->
  ?content_type:string ->
  ?headers:Http_headers.t ->
  ('a, 'b) Eliom_registration.kind ->
  ('a, 'b) Eliom_registration.kind Lwt.t

The function send page build the HTTP frame corresponding to page. This may be used for example in an service handler registered with Eliom_registration.​Any.​register or when building a custom output module.