package eliom

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Eliom service registration for services that returns a redirections towards another service. See the Eliom manual for more information about <<a_manual chapter="server-outputs" fragment="redirections"|Redirections outputs>>.

The default returned HTTP code is 302 Found. You could use the optional parameter ~options to change this value:

  • `MovedPermanently to return 301 Moved Permanently.
  • `Found to return 302 Found.
  • `SeeOther to return 303 See Other.
  • `NotNodifed to return 304 Not Modified.
  • `UseProxy to return 305 Use Proxy.
  • `TemporaryRedirect to return 307 Temporary Redirect.
include Eliom_registration_sigs.S_poly_with_create with type 'a page = 'a redirection and type options = [ `MovedPermanently | `Found | `SeeOther | `NotNodifed | `UseProxy | `TemporaryRedirect ] and type 'a return = 'a
include Eliom_registration_sigs.S_poly with type 'a page = 'a redirection with type options = [ `MovedPermanently | `Found | `SeeOther | `NotNodifed | `UseProxy | `TemporaryRedirect ] with type 'a return = 'a
type 'a page = 'a redirection
type options = [
  1. | `MovedPermanently
  2. | `Found
  3. | `SeeOther
  4. | `NotNodifed
  5. | `UseProxy
  6. | `TemporaryRedirect
]
type 'a return = 'a
val register : ?app:string -> ?scope:[< Eliom_common.scope ] -> ?options:options -> ?charset:string -> ?code:int -> ?content_type:string -> ?headers:Cohttp.Header.t -> ?secure_session:bool -> service: ('get, 'post, _, _, _, Eliom_service.non_ext, Eliom_service.reg, _, _, _, 'a return) Eliom_service.t -> ?error_handler:((string * exn) list -> 'a page Lwt.t) -> ('get -> 'post -> 'a page Lwt.t) -> unit

See S.register.

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, 'tipo, 'gp_) Eliom_service.meth -> path:('att, 'co, 'gp_) Eliom_service.path_option -> ?error_handler:((string * exn) list -> 'a page Lwt.t) -> ('gp -> 'pp -> 'a page Lwt.t) -> ('gp, 'pp, 'm, 'att, 'co, Eliom_service.non_ext, Eliom_service.reg, 'tipo, 'gn, 'pn, 'a return) Eliom_service.t

See S_with_create.create.

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, _, [ `WithoutSuffix ], unit, unit, 'a return) Eliom_service.t -> get_params:('gp, [ `WithoutSuffix ], 'gn) Eliom_parameter.params_type -> ?error_handler:((string * exn) list -> 'a page Lwt.t) -> ('gp -> unit -> 'a page Lwt.t) -> ('gp, unit, Eliom_service.get, Eliom_service.att, Eliom_service.co, Eliom_service.non_ext, Eliom_service.reg, [ `WithoutSuffix ], 'gn, unit, 'a return) Eliom_service.t

See S_with_create.create_attached_get.

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, _, [ `WithoutSuffix ], 'gn, unit, 'a return) Eliom_service.t -> post_params:('pp, [ `WithoutSuffix ], 'pn) Eliom_parameter.params_type -> ?error_handler:((string * exn) list -> 'a page Lwt.t) -> ('gp -> 'pp -> 'a page Lwt.t) -> ('gp, 'pp, Eliom_service.post, Eliom_service.att, Eliom_service.co, Eliom_service.non_ext, Eliom_service.reg, [ `WithoutSuffix ], 'gn, 'pn, 'a return) Eliom_service.t

See S_with_create.create_attached_post.

val send : ?options:options -> ?charset:string -> ?code:int -> ?content_type:string -> ?headers:Ocsigen_header.t -> _ page -> _ kind Lwt.t

More polymorphic version of Eliom_registration_sigs.send