Mercurial > prosody-modules

comparison mod_smacks/README.markdown @ 2394:4c27ebcf4cbd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file)
author tmolitor <thilo@eightysoft.de>
date Thu, 24 Nov 2016 00:47:32 +0100
parents ada71b81425a
children 7036a6e074d7
comparison
equal deleted inserted replaced
2393:3b2c94ea0c2e 2394:4c27ebcf4cbd
29 29
30 If the client fails to reconnect before the timeout then it is marked 30 If the client fails to reconnect before the timeout then it is marked
31 offline as normal, and any stanzas in the queue are returned to the 31 offline as normal, and any stanzas in the queue are returned to the
32 sender as a "recipient-unavailable" error. 32 sender as a "recipient-unavailable" error.
33 33
34 If you don't want this behaviour on timeout you can use [mod_smacks_offline]
35 or [mod_smacks_noerror] to customize the behaviour further.
36
37 This module also provides some events used by [mod_cloud_notify].
38 These events are: "smacks-ack-delayed", "smacks-hibernation-start" and
39 "smacks-hibernation-end". See [mod_cloud_notify] for details on how this
40 events are used there.
41
34 Configuration 42 Configuration
35 ============= 43 =============
36 44
37 Option Default Description 45 Option Default Description
38 ------------------------------ ----------------- ----------------------------------------------------------------------------------------- 46 ------------------------------ ----------------- -----------------------------------------------------------------------------------------
39 `smacks_hibernation_time` 300 (5 minutes) The number of seconds a disconnected session should stay alive for (to allow reconnect) 47 `smacks_hibernation_time` 300 (5 minutes) The number of seconds a disconnected session should stay alive for (to allow reconnect)
40 `smacks_enabled_s2s` false Enable Stream Management on server connections? *Experimental* 48 `smacks_enabled_s2s` false Enable Stream Management on server connections? *Experimental*
41 `smacks_max_unacked_stanzas` 0 How many stanzas to send before requesting acknowledgement 49 `smacks_max_unacked_stanzas` 0 How many stanzas to send before requesting acknowledgement
50 `smacks_max_ack_delay` 60 (1 minute) The number of seconds an ack must be unanswered to trigger an "smacks-ack-delayed" event
42 51
43 Compatibility 52 Compatibility
44 ============= 53 =============
45 54
46 ----- ----------------------------------- 55 ----- -----------------------------------
56 0.10 Works
47 0.9 Works 57 0.9 Works
48 0.8 Works, use version [7693724881b3] 58 0.8 Works, use version [7693724881b3]
49 ----- ----------------------------------- 59 ----- -----------------------------------
50 60
51 61
59 - Psi (in an unreleased branch) 69 - Psi (in an unreleased branch)
60 - Conversations 70 - Conversations
61 - Yaxim 71 - Yaxim
62 72
63 [7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua 73 [7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua
74 [mod_smacks_offline]: //modules.prosody.im/mod_smacks_offline
75 [mod_smacks_noerror]: //modules.prosody.im/mod_smacks_noerror
76 [mod_cloud_notify]: //modules.prosody.im/mod_cloud_notify