Ocsigen

Eliom

Home

Doc

Blog

Eliom

Js_of_ocaml

Server

Lwt

Tyxml

Start

Module Eliom.Common

include module type of struct include Common_base end
exception Site_information_not_available of string
exception Eliom_site_information_not_available of string
type scope_hierarchy = Common_base.scope_hierarchy =
  1. | User_hier of string
  2. | Default_ref_hier
  3. | Default_comet_hier
val scope_hierarchy_of_json : Deriving_Json_lexer.lexbuf -> scope_hierarchy
val scope_hierarchy_to_json : Buffer.t -> scope_hierarchy -> unit
val scope_hierarchy_json : scope_hierarchy Deriving_Json.t
type user_scope = [
  1. | `Session_group of scope_hierarchy
  2. | `Session of scope_hierarchy
  3. | `Client_process of scope_hierarchy
]
val user_scope_recognize : [ `Cst of int | `NCst of int ] -> bool
val user_scope_of_json_with_tag : Deriving_Json_lexer.lexbuf -> [ `Cst of int | `NCst of int ] -> user_scope
val user_scope_of_json : Deriving_Json_lexer.lexbuf -> user_scope
val user_scope_to_json : Buffer.t -> user_scope -> unit
val user_scope_json : user_scope Deriving_Json.t
type scope = [
  1. | `Site
  2. | user_scope
]
type all_scope = [
  1. | scope
  2. | `Global
  3. | `Request
]
type global_scope = [
  1. | `Global
]
type site_scope = [
  1. | `Site
]
type session_group_scope = [
  1. | `Session_group of scope_hierarchy
]
type session_scope = [
  1. | `Session of scope_hierarchy
]
type client_process_scope = [
  1. | `Client_process of scope_hierarchy
]
type request_scope = [
  1. | `Request
]
type user_level = [
  1. | `Session_group
  2. | `Session
  3. | `Client_process
]
val level_of_user_scope : [< `Client_process of scope_hierarchy & 'a | `Session of scope_hierarchy & 'b | `Session_group of scope_hierarchy & 'c ] -> [> user_level ]
val scope_hierarchy_of_user_scope : [< user_scope ] -> scope_hierarchy
type full_state_name = Common_base.full_state_name = {
  1. user_scope : user_scope;
  2. secure : bool;
  3. site_dir_str : string;
}
val full_state_name_of_json : Deriving_Json_lexer.lexbuf -> full_state_name
val full_state_name_to_json : Buffer.t -> full_state_name -> unit
val full_state_name_json : full_state_name Deriving_Json.t
module Full_state_name_table = Common_base.Full_state_name_table
type state_cookies = Common_base.state_cookies = {
  1. service_cookies : string Full_state_name_table.t;
  2. data_cookies : string Full_state_name_table.t;
  3. persistent_cookies : string Full_state_name_table.t;
}
val no_state_cookies : state_cookies
type csrf_info = Common_base.csrf_info = {
  1. csrf_id : int;
    (*

    Unique id

    *)
  2. csrf_scope : user_scope;
    (*

    Scope of the delayed registration, if the service is registered in the global table

    *)
  3. csrf_secure : bool option;
    (*

    ?secure parameter of the delayed registration, likewise

    *)
}
type att_key_serv = Common_base.att_key_serv =
  1. | SAtt_no
  2. | SAtt_named of string
  3. | SAtt_anon of string
  4. | SAtt_csrf_safe of csrf_info
  5. | SAtt_na_named of string
  6. | SAtt_na_anon of string
  7. | SAtt_na_csrf_safe of csrf_info
type na_key_serv = Common_base.na_key_serv =
  1. | SNa_no
  2. | SNa_void_keep
  3. | SNa_void_dontkeep
  4. | SNa_get_ of string
  5. | SNa_post_ of string
  6. | SNa_get' of string
  7. | SNa_post' of string
  8. | SNa_get_csrf_safe of csrf_info
  9. | SNa_post_csrf_safe of csrf_info
type att_key_req = Common_base.att_key_req =
  1. | RAtt_no
  2. | RAtt_named of string
  3. | RAtt_anon of string
type na_key_req = Common_base.na_key_req =
  1. | RNa_no
  2. | RNa_get_ of string
  3. | RNa_post_ of string
  4. | RNa_get' of string
  5. | RNa_post' of string
val att_key_serv_of_req : att_key_req -> att_key_serv
val na_key_serv_of_req : na_key_req -> na_key_serv
val defaultpagename : string
val eliom_suffix_name : string
val eliom_suffix_internal_name : string
val eliom_nosuffix_page : string
val naservice_num : string
val naservice_name : string
val get_state_param_name : string
val post_state_param_name : string
val get_numstate_param_name : string
val post_numstate_param_name : string
val co_param_prefix : string
val na_co_param_prefix : string
val nl_param_prefix : string
val pnl_param_prefix : string
val npnl_param_prefix : string
val eliom_internal_nlp_prefix : string
val tab_cookies_param_name : string
val to_be_considered_as_get_param_name : string
val appl_name_header_name : string
val full_xhr_redir_header : string
val half_xhr_redir_header : string
val response_url_header : string
val set_tab_cookies_header_name : string
val tab_cookies_header_name : string
val tab_cpi_header_name : string
val expecting_process_page_name : string
val base_elt_id : string
val nl_is_persistent : string -> bool
type client_process_info = Common_base.client_process_info = {
  1. cpi_ssl : bool;
  2. cpi_hostname : string;
  3. cpi_server_port : int;
  4. cpi_original_full_path : string list;
}
val client_process_info_of_json : Deriving_Json_lexer.lexbuf -> client_process_info
val client_process_info_to_json : Buffer.t -> client_process_info -> unit
val client_process_info_json : client_process_info Deriving_Json.t
type sess_info = Common_base.sess_info = {
  1. si_other_get_params : (string * string) list;
  2. si_all_get_params : (string * string) list;
  3. si_all_post_params : (string * string) list option;
  4. si_all_file_params : (string * Lib.file_info) list option;
  5. si_state_cookies : state_cookies;
  6. si_secure_state_cookies : state_cookies;
  7. si_state_cookies_tab : state_cookies;
  8. si_secure_state_cookies_tab : state_cookies;
  9. si_tab_cookies : string Ocsigen_cookie_map.Map_inner.t;
  10. si_nonatt_info : na_key_req;
  11. si_state_info : att_key_req * att_key_req;
  12. si_previous_extension_error : int;
  13. si_na_get_params : (string * string) list Lazy.t;
  14. si_nl_get_params : (string * string) list Lib.String.Table.t;
  15. si_nl_post_params : (string * string) list Lib.String.Table.t;
  16. si_nl_file_params : (string * Lib.file_info) list Lib.String.Table.t;
  17. si_persistent_nl_get_params : (string * string) list Lib.String.Table.t Lazy.t;
  18. si_all_get_but_na_nl : (string * string) list Lazy.t;
  19. si_all_get_but_nl : (string * string) list;
  20. si_ignored_get_params : (string * string) list;
  21. si_ignored_post_params : (string * string) list;
  22. si_client_process_info : client_process_info option;
  23. si_expect_process_data : bool Lazy.t;
}
type eliom_js_page_data = Common_base.eliom_js_page_data = {
  1. ejs_global_data : (Runtime.global_data * Wrap.unwrapper) option;
  2. ejs_request_data : Runtime.request_data;
  3. ejs_event_handler_table : Ocsigen_lib_base.poly Runtime.RawXML.ClosureMap.t;
  4. ejs_client_attrib_table : Ocsigen_lib_base.poly Runtime.RawXML.ClosureMap.t;
  5. ejs_sess_info : sess_info;
}
val tyxml_unwrap_id_int : int
val comet_channel_unwrap_id_int : int
val react_up_unwrap_id_int : int
val react_down_unwrap_id_int : int
val signal_down_unwrap_id_int : int
val bus_unwrap_id_int : int
val client_value_unwrap_id_int : int
val global_data_unwrap_id_int : int
val server_function_unwrap_id_int : int
val site_init_compilation_unit_id : string
type node_ref = string
val nl_get_appl_parameter : string
val make_actual_path : string list -> string list
val is_client_app : bool ref
val prefixlength : int
val prefixlengthminusone : int
val split_nl_prefix_param : (string * 'a) list -> (string * 'a) list Lib.String.Table.t * (string * 'a) list
val split_prefix_param : string -> (string * 'a) list -> (string * 'a) list * (string * 'a) list
val remove_prefixed_param : string -> (string * 'a) list -> (string * 'a) list
val remove_na_prefix_params : (string * 'a) list -> (string * 'a) list
val filter_na_get_params : (string * string) list -> (string * string) list
exception Eliom_404

Service called with wrong parameter names

exception Eliom_Wrong_parameter
exception Eliom_duplicate_registration of string
exception Eliom_page_erasing of string
type 'a dircontent = 'a Common_base.dircontent =
  1. | Empty
  2. | Table of 'a direlt ref Lib.String.Table.t
and 'a direlt = 'a Common_base.direlt =
  1. | Dir of 'a dircontent ref
  2. | File of 'a ref
val empty_dircontent : unit -> 'a dircontent
type 'a service_table = 'a Common_base.service_table = {
  1. st_generation : int;
  2. st_priority : int;
  3. st_content : 'a dircontent ref;
}
type meth = [
  1. | `Get
  2. | `Post
  3. | `Put
  4. | `Delete
  5. | `Other
]
type page_table_key = Common_base.page_table_key = {
  1. key_state : att_key_serv * att_key_serv;
  2. key_meth : meth;
}
type anon_params_type = int
exception Eliom_Typing_Error of (string * exn) list
type ('params, 'result) service = ('params, 'result) Common_base.service = {
  1. s_id : anon_params_type * anon_params_type;
  2. mutable s_max_use : int option;
  3. s_expire : (float * float ref) option;
  4. s_f : bool -> 'params -> 'result Lwt.t;
}
type 'a to_and_of = 'a Common_base.to_and_of = {
  1. of_string : string -> 'a;
  2. to_string : 'a -> string;
}
val backtrace_lwt : int -> string list
type server_params = unit
val get_sp : unit -> unit
val get_sp_option : unit -> unit option
type 'a wrapper = unit
val make_wrapper : 'b -> 'a wrapper
val empty_wrapper : unit -> 'a wrapper
type unwrap_id = Unwrap.unwrap_id
val react_up_unwrap_id : unwrap_id
val react_down_unwrap_id : unwrap_id
val signal_down_unwrap_id : unwrap_id
val comet_channel_unwrap_id : unwrap_id
val bus_unwrap_id : unwrap_id
val sitedata : Types.sitedata option ref
val global_register_allowed : unit -> (unit -> Types.sitedata) option
val get_site_dir : Types.sitedata -> Lib.Url.path
val get_site_dir_string : Types.sitedata -> string
val add_unregistered : 'a -> 'b -> unit
module To_and_of_shared : sig ... end
val client_html_file : unit -> string
val set_client_html_file : string -> unit
val defer : (unit -> 'a option) -> ('a -> 'b) -> 'b option ref