package eliom

  1. Overview
  2. Docs
package eliom
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Eliom_configSource

This module makes also possible get information from the configuration file.

It make also possible to add configuration options in configuration file for your Eliom modules. Use Eliom_config.parse_config for that.

Example:

     <eliommodule ...>
        <myoption myattr="...">myvalue</myoption>
     </eliommodule>
Sourceval set_session_gc_frequency : int option -> unit

Set frequency for garnage collection of both in memory data and service sessions. None means never.

Sourceval set_service_session_gc_frequency : int option -> unit

Set frequency for garbage collection of service sessions. None means never.

Sourceval set_data_session_gc_frequency : int option -> unit

Set frequency for garbage collection of in memory data sessions. None means never.

Sourceval set_persistent_session_gc_frequency : int option -> unit

Set frequency for garbage collection of persistent data sessions. None means never.

Sourceval set_volatile_timeout : ?scope_hierarchy:Eliom_common.scope_hierarchy -> cookie_level:[< `Session | `Client_process ] -> int option -> unit
Sourceval set_data_timeout : ?scope_hierarchy:Eliom_common.scope_hierarchy -> cookie_level:[< `Session | `Client_process ] -> int option -> unit
Sourceval set_service_timeout : ?scope_hierarchy:Eliom_common.scope_hierarchy -> cookie_level:[< `Session | `Client_process ] -> int option -> unit
Sourceval set_persistent_timeout : ?scope_hierarchy:Eliom_common.scope_hierarchy -> cookie_level:[< `Session | `Client_process ] -> int option -> unit
Sourceval set_max_service_sessions_per_group : int -> unit
Sourceval set_max_volatile_data_sessions_per_group : int -> unit
Sourceval set_max_persistent_data_sessions_per_group : int -> unit
Sourceval set_max_service_tab_sessions_per_group : int -> unit
Sourceval set_max_volatile_data_tab_sessions_per_group : int -> unit
Sourceval set_max_persistent_data_tab_sessions_per_group : int -> unit
Sourceval set_max_anonymous_services_per_session : int -> unit
Sourceval set_max_volatile_groups_per_site : int -> unit
Sourceval set_secure_cookies : bool -> unit
Sourceval set_application_script : (bool * bool) -> unit
Sourceval set_cache_global_data : (Eliom_lib.Url.path * int) option -> unit
Sourceval set_html_content_type : string -> unit
Sourceval add_ignored_get_params : (string * Re.re) -> unit
Sourceval add_ignored_post_params : (string * Re.re) -> unit
Sourceval set_omitpersistentstorage : Eliom_common.omitpersistentstorage_rule list option -> unit
Sourceval get_default_hostname : unit -> string

The function get_default_hostname ()returns the hostname declared in the config file (<host defaulthostname="...">) or the default machine hostname. In that case, absolute URL will use that hostname.

Sourceval get_default_port : unit -> int

The function get_default_port () returns the port number declared in the config file (<host defaulthttpport="...">) or -> unit 80 if undeclared.

Sourceval get_default_sslport : unit -> int

The function get_default_sslport () returns the https port number declared in the config file (<host defaulthttpsport="...">) or 443 if undeclared.

Sourceval default_protocol_is_https : unit -> bool

The function default_protocol_is_https () returns true if there is option (<host defaultprotocol="https">)or false otherwise. In that case, absolute links will use https protocol even if the current request is http.

Sourceval get_config_default_charset : unit -> string

The function get_config_default_charset () returns the default charset for this site.

The provided value serves as a default value for the optional parameter ~xhr in the functions Eliom_registration.*.{a, get_form, post_form, lwt_get_form, lwt_post_form} (cf. Eliom_registration.Html.a et al.). This value can also be set in the config file.

Sourceval get_config : unit -> Xml.xml list

The function get_config () returns the information of the configuration file concerning that site (between <eliommodule> and </eliommodule> or <eliom> and </eliom>).

Warning: You must call that function during the initialisation of your module (not during a Lwt thread or a service) otherwise it will raise the exception Eliom_common.Eliom_site_information_not_available. If you want to build a statically linkable module, you must call this function inside the initialisation function given to Eliom_service.register_eliom_module.

Sourceval parse_config : ?pcdata:(string -> unit) -> ?other_elements:(string -> (string * string) list -> Xml.xml list -> unit) -> Ocsigen_extensions.Configuration.element list -> unit

Process the configuration (same as the one returned by <<a_api module="Eliom_config" | val get_config>> ) by a given specification (cf. <<a_api project="ocsigenserver" | type Ocsigen_extensions.Configuration.element >> )

Sourceval get_config_info : unit -> Ocsigen_extensions.config_info

The function get_config_info () returns the information concerning the current request from the configuration files (must be called during a request). The configuration may have been modified by previous Ocsigen server extensions.

Sourceval get_debugmode : unit -> bool

Same as Ocsigen_config.get_debugmode. On client side, returns false for now.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct