equal
deleted
inserted
replaced
7 Introduction |
7 Introduction |
8 ============ |
8 ============ |
9 |
9 |
10 This is an implementation of the server bits of [XEP-0357: Push Notifications]. |
10 This is an implementation of the server bits of [XEP-0357: Push Notifications]. |
11 It allows clients to register an "app server" which is notified about new |
11 It allows clients to register an "app server" which is notified about new |
12 messages while the user is offline or disconnected. Implementation of the |
12 messages while the user is offline, disconnected or the session is hibernated |
13 "app server" is not included[^1]. |
13 by [mod_smacks]. |
|
14 Implementation of the "app server" is not included[^1]. |
14 |
15 |
15 Details |
16 Details |
16 ======= |
17 ======= |
17 |
18 |
18 App servers are notified about offline messages. |
19 App servers are notified about offline messages or messages waiting |
|
20 in the smacks queue. |
|
21 |
|
22 To cooperate with [mod_smacks] this module consumes some events: |
|
23 "smacks-ack-delayed", "smacks-hibernation-start" and "smacks-hibernation-end". |
|
24 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 acknowledgements for messages are delayed by a certain amount of seconds |
|
27 configurable with the [mod_smacks] setting "smacks_max_ack_delay". |
|
28 |
|
29 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 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 circumstances. |
19 |
34 |
20 Configuration |
35 Configuration |
21 ============= |
36 ============= |
22 |
37 |
23 Option Default Description |
38 Option Default Description |
44 |
59 |
45 Should work with 0.9+. |
60 Should work with 0.9+. |
46 |
61 |
47 [^1]: The service which is expected to forward notifications to |
62 [^1]: The service which is expected to forward notifications to |
48 something like Google Cloud Messaging or Apple Notification Service |
63 something like Google Cloud Messaging or Apple Notification Service |
|
64 [mod_smacks]: //modules.prosody.im/mod_smacks |