diff mod_smacks/README.markdown @ 2394:4c27ebcf4cbd

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
line wrap: on
line diff
--- a/mod_smacks/README.markdown	Tue Nov 22 21:15:01 2016 +0100
+++ b/mod_smacks/README.markdown	Thu Nov 24 00:47:32 2016 +0100
@@ -31,6 +31,14 @@
 offline as normal, and any stanzas in the queue are returned to the
 sender as a "recipient-unavailable" error.
 
+If you don't want this behaviour on timeout you can use [mod_smacks_offline]
+or [mod_smacks_noerror] to customize the behaviour further.
+
+This module also provides some events used by [mod_cloud_notify].
+These events are: "smacks-ack-delayed", "smacks-hibernation-start" and
+"smacks-hibernation-end". See [mod_cloud_notify] for details on how this
+events are used there.
+
 Configuration
 =============
 
@@ -39,11 +47,13 @@
   `smacks_hibernation_time`      300 (5 minutes)   The number of seconds a disconnected session should stay alive for (to allow reconnect)
   `smacks_enabled_s2s`           false             Enable Stream Management on server connections? *Experimental*
   `smacks_max_unacked_stanzas`   0                 How many stanzas to send before requesting acknowledgement
+  `smacks_max_ack_delay`         60 (1 minute)     The number of seconds an ack must be unanswered to trigger an "smacks-ack-delayed" event
 
 Compatibility
 =============
 
   ----- -----------------------------------
+  0.10  Works
   0.9   Works
   0.8   Works, use version [7693724881b3]
   ----- -----------------------------------
@@ -61,3 +71,6 @@
 -   Yaxim
 
 [7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua
+[mod_smacks_offline]: //modules.prosody.im/mod_smacks_offline
+[mod_smacks_noerror]: //modules.prosody.im/mod_smacks_noerror
+[mod_cloud_notify]: //modules.prosody.im/mod_cloud_notify