package eliom

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

This module allows access to volatile references for other groups, sessions, or client processes. Use it in conjunction with functions like Eliom_state.Ext.iter_volatile_sub_states to get the sessions from a group (or the processes from a session).

val get : ([< `Session_group | `Session | `Client_process ], [< `Data ]) Eliom_state.Ext.state -> 'a eref -> 'a

get the value of a reference from outside the state. If the value has not been set yet for this state, it will raise exception Eref_not_initialized.

val set : ([< `Session_group | `Session | `Client_process ], [< `Data ]) Eliom_state.Ext.state -> 'a eref -> 'a -> unit
val modify : ([< `Session_group | `Session | `Client_process ], [< `Data ]) Eliom_state.Ext.state -> 'a eref -> ('a -> 'a) -> unit

Warning: the function will be executed with the current context

val unset : ([< `Session_group | `Session | `Client_process ], [< `Data ]) Eliom_state.Ext.state -> 'a eref -> unit
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