.TH "Eliom_comet" 3o 2014-07-10 OCamldoc ""
.SH NAME
Eliom_comet \- Handle unsolicited server to client communications.
.SH Module
Module   Eliom_comet
.SH Documentation
.sp
Module
.BI "Eliom_comet"
 : 
.B sig  end

.sp
Handle unsolicited server to client communications\&.
.sp
See the Eliom manual for a detailed introduction to the concept of
\&.
.sp

.sp

.sp
.sp

.PP

.B === When the page is not active the client stops making comet requests
.B     to the server, implying that the client can\&'t be notified by the
.B     server anymore\&. The activity status is changed when the page is
.B     focused or unfocused\&.
.B 
.B     To stop receiving inputs from a channel, use Lwt\&.cancel on a
.B     thread waiting for data\&. For instance, if you iterate with
.B      let t = Lwt_stream\&.iter f %channel  calling Lwt\&.cancel t
.B     will close the channel\&. ===

.PP

.I exception Channel_full 

.sp

.B Channel_full
is raised when trying to read on a channel marked
full by the server\&. It is not possible to read anything else from a
full channel\&.
.sp

.sp

.I exception Process_closed 

.sp

.B Process_closed
is raised when reading on a channel and the
server side of the application closed the client process\&.
This apply only to stateful channels
.sp

.sp

.I exception Channel_closed 

.sp

.B Process_closed
is raised when reading on a channel and the
server side of the application closed channel ( the channel
was garbage collected )\&. This apply only to stateless channels
.sp

.sp

.I val is_active 
: 
.B unit -> [ `Active | `Idle | `Inactive ]
.sp

.B is_active ()
returns the current activity state
.sp

.sp

.I val activate 
: 
.B unit -> unit
.sp
if the client is inactive 
.B activate ()
launch a new xhr
connection to start receiving server messages
.sp

.sp
.I module Configuration : 
.B sig  end

.sp
Change the reactivity of channels\&. Multiples configurations ( of
type 
.B t
) can be created\&. The resulting behaviour is the minimal
( in the meaning of maximal reactivity ) between all
configurations
.sp

.sp
.I module Channel : 
.B sig  end

.sp

.sp