mod_cloud_notify/README.markdown
changeset 2613 6ab46ff685d0
parent 2399 2e641ab995b3
child 2615 4d81d7219db0
equal deleted inserted replaced
2612:362ca94192ee 2613:6ab46ff685d0
    14 Implementation of the "app server" is not included[^1].
    14 Implementation of the "app server" is not included[^1].
    15 
    15 
    16 Details
    16 Details
    17 =======
    17 =======
    18 
    18 
    19 App servers are notified about offline messages or messages waiting
    19 App servers are notified about offline messages, messages stored by [mod_mam]
    20 in the smacks queue.
    20 or messages waiting in the smacks queue.
       
    21 The business rules outlined [here] are all honored[^2].
    21 
    22 
    22 To cooperate with [mod_smacks] this module consumes some events:
    23 To cooperate with [mod_smacks] this module consumes some events:
    23 "smacks-ack-delayed", "smacks-hibernation-start" and "smacks-hibernation-end".
    24 "smacks-ack-delayed", "smacks-hibernation-start" and "smacks-hibernation-end".
    24 These events allow this module to send out notifications for messages received
    25 These events allow this module to send out notifications for messages received
    25 while the session is hibernated by [mod_smacks] or even when smacks
    26 while the session is hibernated by [mod_smacks] or even when smacks
    29 The "smacks_max_ack_delay" setting allows to send out notifications to clients
    30 The "smacks_max_ack_delay" setting allows to send out notifications to clients
    30 which aren't already in smacks hibernation state (because the read timeout or
    31 which aren't already in smacks hibernation state (because the read timeout or
    31 connection close didn't happen already) but also aren't responding to acknowledgement
    32 connection close didn't happen already) but also aren't responding to acknowledgement
    32 request in a timely manner, thus allowing conversations to be smoother under such
    33 request in a timely manner, thus allowing conversations to be smoother under such
    33 circumstances.
    34 circumstances.
       
    35 
       
    36 The new event "cloud-notify-ping" can be used by any module to send out a cloud
       
    37 notification to either all registered endpoints for the given user or only the endpoints
       
    38 given in the event data.
    34 
    39 
    35 Configuration
    40 Configuration
    36 =============
    41 =============
    37 
    42 
    38   Option                            Default   Description
    43   Option                            Default   Description
    59 
    64 
    60 Should work with 0.9+.
    65 Should work with 0.9+.
    61 
    66 
    62 [^1]: The service which is expected to forward notifications to
    67 [^1]: The service which is expected to forward notifications to
    63     something like Google Cloud Messaging or Apple Notification Service
    68     something like Google Cloud Messaging or Apple Notification Service
    64 [mod_smacks]: //modules.prosody.im/mod_smacks
    69 [here]: https://mail.jabber.org/pipermail/standards/2016-February/030925.html
       
    70 [^2]: //hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md