.TH "Eliom_comet.Configuration" 3o 2014-07-10 OCamldoc ""
.SH NAME
Eliom_comet.Configuration \- Change the reactivity of channels.
.SH Module
Module   Eliom_comet.Configuration
.SH Documentation
.sp
Module
.BI "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

.sp
.sp
.I type t 

.sp

.sp

.I val new_configuration 
: 
.B unit -> t
.sp
Creates a new configuration with default value\&. It modifies the
current behaviour immediately
.sp

.sp

.I val drop_configuration 
: 
.B t -> unit
.sp

.B drop_configuration t
restores the behaviour to the minimum of
configuration without 
.B t
\&. If there is no other configuration
than 
.B t
, it is restored to the defaults\&.
.sp

.sp

.I val set_always_active 
: 
.B t -> bool -> unit
.sp

.B set_always_active c b
if b is true, tells the client to always
stay active\&.
Default value is false\&.
.sp

.sp

.I val set_timeout 
: 
.B t -> float -> unit
.sp

.B set_timeout c t
tells the client to stay active at least 
.B t
seconds when the application lose the focus\&.
Default value is 180\&.
.sp

.sp

.I val set_active_until_timeout 
: 
.B t -> bool -> unit
.sp

.B set_active_until_timeout c v
sets the activity changing
behaviour\&. if 
.B v
is 
.B true
the page is kept active even if not
focused until the client receive a timeout message from the
server\&. It implies that if the server keeps sending data to the
client, the comet connection will never be closed\&.
Default value is false\&.
.sp

.sp

.I val set_time_between_requests 
: 
.B t -> float -> unit
.sp
after 
.B set_time_between_requests t v
, the main loop will wait for
.B v
seconds between two requests\&. It is taken into account
immediately\&.
Default value is 0\&.
.sp

.sp

.I val set_time_between_requests_when_idle 
: 
.B t -> float * float -> unit
.sp

.B set_time_between_requests_when_idle c (a, b)
sets the time
between two requests when the the windows does not have the focus,
after the timeout\&.
This amount of time is computed using an affine function
(a * t + b), where t is the amount of time elapsed since the begining
of the idle phase\&.
If you want no request at all, do 
.B set_always_active false
\&.
Setting this to 
.B (0\&., 0\&.)
is equivalent
to 
.B set_always_active true
\&.
Default value is 
.B (0\&.0078125, 0\&.)
\&.
.sp

.sp