trusty (3) Eliom_reference.Volatile.Ext.server.3o.gz

NAME

       Eliom_reference.Volatile.Ext - no description

Module

       Module   Eliom_reference.Volatile.Ext

Documentation

       Module Ext
        : sig end

       ===  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_on_all_volatile_data_sessions_from_group
       to get the sessions from a group (or the processes from a session). ===

       val  get  :  ([<  `Client_process  | `Session | `Session_group ], [< `Data ]) Eliom_state.Ext.state -> 'a
       Eliom_reference.Volatile.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_intialized .

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

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

       Warning: the function will be executed with the current context

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