Mercurial > prosody-modules
comparison mod_push2/README.markdown @ 5659:4d1a3de56c3d
Initial work on Push 2.0
| author | Stephen Paul Weber <singpolyma@singpolyma.net> |
|---|---|
| date | Tue, 19 Sep 2023 21:21:17 -0500 |
| parents | |
| children | 13c9ed6844ff |
comparison
equal
deleted
inserted
replaced
| 5658:7a4a6ded2bd6 | 5659:4d1a3de56c3d |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha | |
| 4 summary: 'Push 2.0' | |
| 5 --- | |
| 6 | |
| 7 The way forward for push notifications? You are probably looking for | |
| 8 `mod_cloud_notify` for now though | |
| 9 | |
| 10 See also https://hg.prosody.im/prosody-modules/file/tip/mod_push2/push2.markdown | |
| 11 | |
| 12 Configuration | |
| 13 ============= | |
| 14 | |
| 15 Option Default Description | |
| 16 ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- | |
| 17 `contact_uri` xmpp:server.tld Contact information for the server operator (usually as a `mailto:` URI is preferred) | |
| 18 `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) | |
| 19 | |
| 20 Internal design notes | |
| 21 ===================== | |
| 22 | |
| 23 App servers are notified about messages stored by [mod_mam] | |
| 24 or messages waiting in the smacks queue. | |
| 25 | |
| 26 Currently messages that go into the offline queue but not into MAM are | |
| 27 not delivered. Need to come up with a way to dedup these. Or just have | |
| 28 your MAM set to always. | |
| 29 | |
| 30 To cooperate with [mod_smacks] this module consumes some events: | |
| 31 `smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`. | |
| 32 These events allow this module to send out notifications for messages received | |
| 33 while the session is hibernated by [mod_smacks] or even when smacks | |
| 34 acknowledgements for messages are delayed by a certain amount of seconds | |
| 35 configurable with the [mod_smacks] setting `smacks_max_ack_delay`. | |
| 36 | |
| 37 The `smacks_max_ack_delay` setting allows to send out notifications to clients | |
| 38 which aren't already in smacks hibernation state (because the read timeout or | |
| 39 connection close didn't already happen) but also aren't responding to acknowledgement | |
| 40 request in a timely manner. This setting thus allows conversations to be smoother | |
| 41 under such circumstances. | |
| 42 | |
| 43 Compatibility | |
| 44 ============= | |
| 45 | |
| 46 **Note:** This module should be used with Lua 5.3 and higher. | |
| 47 | |
| 48 ------ ----------------------------------------------------------------------------- | |
| 49 trunk Works | |
| 50 ------ ----------------------------------------------------------------------------- |