prosody-modules
ffb6646b4253
mod_smacks/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_smacks/README.markdown @ 2596:ffb6646b4253

Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user Revision 1.5.2 allows sending h-values on resumes that fail due to hibernation timeout and to send out a smacks ack directly before the stream close tag. I also made the used timers stoppable even for prosody 0.10 and below, this makes the smacks-ack-delayed event more useful.
author tmolitor <thilo@eightysoft.de>
date Sun, 05 Mar 2017 20:23:53 +0100
parent 2503:7036a6e074d7
child 3967:0957ba6aeb99
comparison
equal deleted inserted replaced
2595:307ddebb72e1 2596:ffb6646b4253
37 This module also provides some events used by [mod_cloud_notify]. 37 This module also provides some events used by [mod_cloud_notify].
38 These events are: "smacks-ack-delayed", "smacks-hibernation-start" and 38 These events are: "smacks-ack-delayed", "smacks-hibernation-start" and
39 "smacks-hibernation-end". See [mod_cloud_notify] for details on how this 39 "smacks-hibernation-end". See [mod_cloud_notify] for details on how this
40 events are used there. 40 events are used there.
41 41
42 Use prosody 0.10+ to have per user limits on allowed sessions in hibernation
43 state and allowed sessions for which the h-value is kept even after the
44 hibernation timed out.
45 These are settable using `smacks_max_hibernated_sessions` and `smacks_max_old_sessions`.
46
42 Configuration 47 Configuration
43 ============= 48 =============
44 49
45 Option Default Description 50 Option Default Description
46 ------------------------------ ----------------- ----------------------------------------------------------------------------------------- 51 ---------------------------------- ----------------- ------------------------------------------------------------------------------------------------------------------
47 `smacks_hibernation_time` 300 (5 minutes) The number of seconds a disconnected session should stay alive for (to allow reconnect) 52 `smacks_hibernation_time` 300 (5 minutes) The number of seconds a disconnected session should stay alive for (to allow reconnect)
48 `smacks_enabled_s2s` false Enable Stream Management on server connections? *Experimental* 53 `smacks_enabled_s2s` false Enable Stream Management on server connections? *Experimental*
49 `smacks_max_unacked_stanzas` 0 How many stanzas to send before requesting acknowledgement 54 `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 55 `smacks_max_ack_delay` 60 (1 minute) The number of seconds an ack must be unanswered to trigger an "smacks-ack-delayed" event
56 `smacks_max_hibernated_sessions` 10 The number of allowed sessions in hibernated state (limited per user)
57 `smacks_max_old_sessions` 10 The number of allowed sessions with timed out hibernation for which the h-value is still kept (limited per user)
51 58
52 Compatibility 59 Compatibility
53 ============= 60 =============
54 61
55 ----- ----------------------------------- 62 ----- -----------------------------------------------------------------------------
56 0.10 Works 63 0.10 Works
57 0.9 Works 64 0.9 Works, no per user limit of hibernated sessions
58 0.8 Works, use version [7693724881b3] 65 0.8 Works, no per user limit of hibernated sessions, use version [7693724881b3]
59 ----- ----------------------------------- 66 ----- -----------------------------------------------------------------------------
60 67
61 68
62 Clients 69 Clients
63 ======= 70 =======
64 71
65 Clients that support [XEP-0198]: 72 Clients that support [XEP-0198]:
66 73
67 - Gajim 74 - Gajim (Linux, Windows, OS X)
75 - Conversations (Android)
76 - ChatSecure (iOS)
68 - Swift (but not resumption, as of version 2.0 and alphas of 3.0) 77 - Swift (but not resumption, as of version 2.0 and alphas of 3.0)
69 - Psi (in an unreleased branch) 78 - Psi (in an unreleased branch)
70 - Conversations 79 - Yaxim (Android)
71 - Yaxim 80 - Monal (iOS)
72 81
73 [7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua 82 [7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua
74 [mod_smacks_offline]: //modules.prosody.im/mod_smacks_offline 83 [mod_smacks_offline]: //modules.prosody.im/mod_smacks_offline
75 [mod_smacks_noerror]: //modules.prosody.im/mod_smacks_noerror 84 [mod_smacks_noerror]: //modules.prosody.im/mod_smacks_noerror
76 [mod_cloud_notify]: //modules.prosody.im/mod_cloud_notify 85 [mod_cloud_notify]: //modules.prosody.im/mod_cloud_notify