Module Description
This module is a generic interface for event pushing backends.
It defines a single hook, push_event/3
that forwards the event to all registered backends.
Each backend decides how and if to handle the event in its push_event/2
implementation.
The events are standardized as records that can be found in mod_event_pusher_events.hrl
file.
Common events like user presence changes (offline and online), chat and groupchat messages (incoming and outgoing) are already hooked up to the frontend via mod_event_pusher_hook_translator
which is a proxy between various hooks and push_event/3
hook handler.
Options
- backends (required, list) - Specifies backends to register with the frontend, along with arguments that will be passed to the backend. Currently supported backends include sns, push and http_notification. Refer to their specific documentation to learn more about their functions and configuration options.
Example configuration
{mod_event_pusher, [
{backends, [
{sns, [
{access_key_id, "AKIAIOSFODNN7EXAMPLE"},
{secret_access_key, "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"},
% ...
]},
{push, [
{backend, mnesia},
{wpool, [{workers, 200}]},
{plugin_module, mod_event_pusher_push_plugin_defaults}
]}
]}
]}