Up  Next

Module Eliom_registration.Html

module Html: Eliom_registration_sigs.S_with_create 
  with type page = Html_types.html Eliom_content.Html.elt
   and type options = unit
   and type return = Eliom_service.non_ocaml
   and type result = browser_content kind

Eliom service registration for services that return HTML pages.

include Eliom_registration_sigs.S
val create : ?app:string ->
       ?scope:[< Eliom_common.scope ] ->
       ?options:options ->
       ?charset:string ->
       ?code:int ->
       ?content_type:string ->
       ?headers:Cohttp.Header.t ->
       ?secure_session:bool ->
       ?https:bool ->
       ?name:string ->
       ?csrf_safe:bool ->
       ?csrf_scope:[< Eliom_common.user_scope ] ->
       ?csrf_secure:bool ->
       ?max_use:int ->
       ?timeout:float ->
       meth:('m, 'gp, 'gn, 'pp, 'pn, [< `WithSuffix | `WithoutSuffix ] as 'a, 'gp_)
            Eliom_service.meth ->
       path:('att, 'co, 'gp_) Eliom_service.path_option ->
       ?error_handler:((string * exn) list -> page Lwt.t) ->
       ('gp -> 'pp -> page Lwt.t) ->
       ('gp, 'pp, 'm, 'att, 'co, Eliom_service.non_ext, Eliom_service.reg, 'a, 'gn,
        'pn, return)
       Eliom_service.t

Create a service and register it at the same time. It calls Eliom_service.create and then performs Eliom_registration_sigs.S.register. Returns the service.

val create_attached_get : ?app:string ->
       ?scope:[< Eliom_common.scope ] ->
       ?options:options ->
       ?charset:string ->
       ?code:int ->
       ?content_type:string ->
       ?headers:Cohttp.Header.t ->
       ?secure_session:bool ->
       ?https:bool ->
       ?name:string ->
       ?csrf_safe:bool ->
       ?csrf_scope:[< Eliom_common.user_scope ] ->
       ?csrf_secure:bool ->
       ?max_use:int ->
       ?timeout:float ->
       fallback:(unit, unit, Eliom_service.get, Eliom_service.att,
                 Eliom_service.non_co, Eliom_service.non_ext, 'a,
                 [ `WithoutSuffix ], unit, unit, return)
                Eliom_service.t ->
       get_params:('gp, [ `WithoutSuffix ], 'gn) Eliom_parameter.params_type ->
       ?error_handler:((string * exn) list -> page Lwt.t) ->
       ('gp -> unit -> page Lwt.t) ->
       ('gp, unit, Eliom_service.get, Eliom_service.att, Eliom_service.co,
        Eliom_service.non_ext, Eliom_service.reg, [ `WithoutSuffix ], 'gn, unit,
        return)
       Eliom_service.t

Create an attached service and register it at the same time. It calls Eliom_service.create_attached_get and then performs Eliom_registration_sigs.S.register. Returns the new service.

val create_attached_post : ?app:string ->
       ?scope:[< Eliom_common.scope ] ->
       ?options:options ->
       ?charset:string ->
       ?code:int ->
       ?content_type:string ->
       ?headers:Cohttp.Header.t ->
       ?secure_session:bool ->
       ?https:bool ->
       ?name:string ->
       ?csrf_safe:bool ->
       ?csrf_scope:[< Eliom_common.user_scope ] ->
       ?csrf_secure:bool ->
       ?max_use:int ->
       ?timeout:float ->
       fallback:('gp, unit, Eliom_service.get, Eliom_service.att,
                 Eliom_service.non_co, Eliom_service.non_ext, 'a,
                 [ `WithoutSuffix ], 'gn, unit, return)
                Eliom_service.t ->
       post_params:('pp, [ `WithoutSuffix ], 'pn) Eliom_parameter.params_type ->
       ?error_handler:((string * exn) list -> page Lwt.t) ->
       ('gp -> 'pp -> page Lwt.t) ->
       ('gp, 'pp, Eliom_service.post, Eliom_service.att, Eliom_service.co,
        Eliom_service.non_ext, Eliom_service.reg, [ `WithoutSuffix ], 'gn, 'pn,
        return)
       Eliom_service.t

Create an attached POST service and register it at the same time. It calls Eliom_service.create_attached_post and then performs Eliom_registration_sigs.S.register. Returns the new service.