.TH "Eliom_reference.Volatile.Ext" 3o 2014-07-10 OCamldoc ""
.SH NAME
Eliom_reference.Volatile.Ext \- no description
.SH Module
Module   Eliom_reference.Volatile.Ext
.SH Documentation
.sp
Module
.BI "Ext"
 : 
.B sig  end

.sp

.sp

.sp
.sp

.PP

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

.PP

.I val get 
: 
.B ([< `Client_process | `Session | `Session_group ], [< `Data ])
.B   Eliom_state.Ext.state -> 'a Eliom_reference.Volatile.eref -> 'a
.sp
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 
.B Eref_not_initialized
\&.
.sp

.sp

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

.sp

.I val modify 
: 
.B ([< `Client_process | `Session | `Session_group ], [< `Data ])
.B   Eliom_state.Ext.state ->
.B   'a Eliom_reference.Volatile.eref -> ('a -> 'a) -> unit
.sp
Warning: the function will be executed with the current context
.sp

.sp

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

.sp