.TH "Eliom_react.Down" 3o 2014-07-10 OCamldoc ""
.SH NAME
Eliom_react.Down \- Event from server to client.
.SH Module
Module   Eliom_react.Down
.SH Documentation
.sp
Module
.BI "Down"
 : 
.B sig  end

.sp
Event from server to client\&.
.sp

.sp

.sp
.sp

.PP

.B === A "Down event" (AKA down\-going event) is an event which occurrences are
.B       transmitted asynchronously to the client\&. Even if they are named "events",
.B       it might be better to consider them as asynchronous server\-to\-client
.B       edges in the react events dependency graph\&.
.B 
.B       To use this, call function of_react on server side,
.B       and just use the returned value as a react event on client side\&.
.B       Example:
.B       let e = of_react \&.\&.\&. in \&.\&.\&. {{ \&.\&.\&. React\&.E\&.map f %e; \&.\&.\&. }} ===

.PP
.I type 
.B 'a
.I t 

.sp
The abstract type of down events\&.
.sp

.sp

.I val of_react 
: 
.B ?scope:[< Eliom_comet.Channel.comet_scope ] ->
.B   ?throttling:float ->
.B   ?name:string -> ?size:int -> 'a React.E.t -> 'a t
.sp

.B of_react ?scope ?throttling ?name e
create an
asynchronous edge originating from 
.B e
\&. The parameters are:
.sp
\-
.B throttling
for the limit to event propagation rate (minimum time, in second,
between two consecutive events \- other events are lost),
.sp
\-
.B name
for named edges,
.sp
\-
.B size
for the size of the server side buffer\&.
.sp
\-
.B scope
tell which kind of channel this rely on (See 
.B Eliom_comet\&.create
)\&.

.sp

.sp