package eliom
Install
Dune Dependency
Authors
Maintainers
Sources
md5=218bcb5cd275cc05be06574c5fa357fa
sha512=edbf8b084ec1b7439d4715199c22eb925a77a2dcfbe76bb5bbc4b9d076b70be1b0de74f9eab9dfb7854df28d65eb31a4c17380528d4a461d9c2a4222abe804cc
doc/eliom.server/Eliom_notif/Make/index.html
Module Eliom_notif.MakeSource
Use this functor if you need to customise your notifications with client-specific data (or block notifications for specific clients). This is made to work specifically in a multi-server set-up as well, where In a multi-server set-up notifications might need to be serialised twice, once before broadcasting them to the other servers (without client information present), and then once more to forward them to the clients possibly augmenting it with client-specific data or block for specific clients; see ARG.prepare.
Note: The communication between servers is not implemented in this module. To `plug in' your method of transporting notifications between servers you can override S.notify. See the manual for an example (coming soon).
Parameters
Signature
identity is the type of values used to differentiate one listener from another. Typically it will be a user, but it could also for instance be a chat window.
server notification type; Can be different from client_notif.
client notification type; Can be different from server_notif.
Initialise the notification module for the current client. This function needs to be called before using most other functions of this module. It isn't called implicitly during module instantiation because it relies on identity data which might not be available yet.
Deinitialise/deactivate the notification module for the current client.
Call notify key n to send a notification n to all clients currently listening on data referenced by key.
If ~notfor is `Me, notification will not be sent to the tab currently doing the request (the one which caused the notification to happen). Note that if notify is called with ~notfor:`Me outside of a request it will fail. If it is `Id id it won't be sent to the destination defined by id.
Returns the client react event.
'a Eliom_react.Down.t = 'a React.E.t on client side.
Map a function on this event to react to notifications from the server. For example:
let%client handle_notification some_stuff ev = ...
let%server something some_stuff = ignore %client (ignore (React.E.map (handle_notification ~%some_stuff) ~%(Notif_module.client_ev ()) ) : unit)
Call clean () to clear the tables from empty data.