Module Eliom_notif

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.

module type S = sig..end

module type ARG = sig..end

module Make : functor (A : ARG) -> 
  
  S
  with type identity = A.identity
   and type key = A.key
   and type server_notif = A.server_notif
   and type client_notif = A.client_notif

module type ARG_SIMPLE = sig..end

module Make_Simple : functor (A : ARG_SIMPLE) -> 
  
  S
  with type key = A.key
   and type server_notif = A.notification
   and type client_notif = A.notification