Scroll to navigation

Eliom_comet.Configuration(3o) Eliom_comet.Configuration(3o)

NAME

Eliom_comet.Configuration - Change the reactivity of channels.

Module

Module Eliom_comet.Configuration

Documentation

Module Configuration
: sig end
 
 
Change the reactivity of channels. Multiples configurations ( of type t ) can be created. The resulting behaviour is the minimal ( in the meaning of maximal reactivity ) between all configurations
 
 
 
 
 
 
type t
 
 
 
 
 
val new_configuration : unit -> t
 
Creates a new configuration with default value. It modifies the current behaviour immediately
 
 
 
 
val drop_configuration : t -> unit
 
 
drop_configuration t restores the behaviour to the minimum of configuration without t . If there is no other configuration than t , it is restored to the defaults.
 
 
 
 
val set_always_active : t -> bool -> unit
 
 
set_always_active c b if b is true, tells the client to always stay active. Default value is false.
 
 
 
 
val set_timeout : t -> float -> unit
 
 
set_timeout c t tells the client to stay active at least t seconds when the application lose the focus. Default value is 20.
 
 
 
 
val set_active_until_timeout : t -> bool -> unit
 
 
set_active_until_timeout c v sets the activity changing behaviour. if v is 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 datas to the client, the comet connection will never be closed. Default value is false.
 
 
 
 
val set_time_between_request : t -> float -> unit
 
after set_time_between_request t v , the main loop will wait for v seconds between two requests. It is taken into account immediately. Default value is 0.
 
 
 
2012-06-11 OCamldoc