package eliom

  1. Overview
  2. Docs
Advanced client/server Web and mobile framework

Install

dune-project
 Dependency

Authors

Maintainers

Sources

12.0.0.tar.gz
md5=4b220b194b6f4b55595a15de48a77d5f
sha512=030f33a99ad3cdbf8f86cb92bb54665004fd8aed7113733407682c2f8dda035a57915f38084e7ceead488e51765b339e0cd070c649ecbe8a7fb23eb008894a08

doc/eliom.server/Eliom_react/Down/index.html

Module Eliom_react.DownSource

Event from server to client.

A "Down event" (AKA down-going event) is an event which occurrences are transmitted asynchronously to the client. Even if they are named "events", it might be better to consider them as asynchronous server-to-client edges in the react events dependency graph.

To use this, call function of_react on server side, and just use the returned value as a react event on client side. Example: let e = of_react ... in ... {{ ... React.E.map f %e; ... }}

Sourcetype 'a t

The abstract type of down events.

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

of_react ?scope ?throttling ?name e create an asynchronous edge originating from e. The parameters are:

  • throttling for the limit to event propagation rate (minimum time, in second, between two consecutive events - other events are lost),
  • name for named edges,
  • size for the size of the server side buffer.
  • scope tell which kind of channel this rely on (See Eliom_comet.create).