Up – Package index » eliom » Library eliom.server » Eliom_reference » Volatile » Ext

Module `Volatile.Ext`Source

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).

Source

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.

Source

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

Source

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

Source

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