package eliom

You can search for identifiers within the package.

in-package search v0.2.0

Advanced Client/server Web and mobile framework

Install

dune-project

Dependency

ocsigen.org Readme Edit opam file Versions (33)

Authors

D

dev@ocsigen.org

Maintainers

D

dev@ocsigen.org

Sources

10.2.0.tar.gz

md5=089b68d5bac8dfae1116923f6d95b39c

sha512=b4828b57d963d217ca0efd871b1c0b3f8816c7971825eb49d0dc06dbd91004fc659f83f9121d849ab8de47560941d07b2b9c1838b3387e7c1a4d3d6b9058936b

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

Module `Eliom_react.Down`Source

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.

Source

val 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).