module Eliom_notif : sig..end
Server to client notifications.
This module makes it possible for client side applications to be notified of changes on some indexed data (resources) on the server.
Apply functor Make or Make_Simple for each type of data you want to be able to listen on. Each client starts listening on one piece of data by calling function listen with the index of that piece of data as parameter. Client stops listening by calling function unlisten, or when the client side state is closed (by timeout or when the client disconnects for example).
When the data is modified on server side, call function notify with the index of the data, and all clients listening to that piece of data will receive a notification.
The functor will also create a client side react signal that will be updated every time the client is notified.
See module Os_notif in Ocsigen Start for an example of use.
Signature of the functors Eliom_notif.Make and Eliom_notif.Make_Simple.
ARG is for making Make
module Make : functor (A : ARG) ->
with type identity = A.identity
and type key = A.key
and type server_notif = A.server_notif
and type client_notif = A.client_notif
Use this functor if you need to customise your notifications with client-specific data (or block notifications for specific clients).
module type ARG_SIMPLE = sig..end
ARG_SIMPLE is for making Eliom_notif.Make_Simple
module Make_Simple : functor (A : ARG_SIMPLE) ->
with type key = A.key
and type server_notif = A.notification
and type client_notif = A.notification
Use this functor if you have no need of customising your notifications with client-specific data.