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 Dependency

ocsigen.org Readme Edit opam file Versions (33)

Authors

D

dev@ocsigen.org

Maintainers

D

dev@ocsigen.org

Sources

11.0.0.tar.gz

md5=1c1f8e90f27f81f0e7f002e79340d200

sha512=4c4266c2f979e6d23a7ed385d92e3c6513e27e6372e532171a1d03e385c5fb15ad791e23cee22d9411b253526094eba8496d5bd564b1feea8c6ded738cddda24

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