# HG changeset patch
# User MWild1
# Date 1301067500 0
# Node ID c9bd647b287d47eeee23d5b8f8f66d98be63f60a
# Parent  646b770eb1c34d60a7d3a0e22f3b41c72c4f51ef
Created wiki page through web user interface.

diff -r 646b770eb1c3 -r c9bd647b287d mod_smacks.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_smacks.wiki	Fri Mar 25 15:38:20 2011 +0000
@@ -0,0 +1,26 @@
+#summary XEP-0198: Reliability and fast reconnects for XMPP
+#labels Stage-Beta
+
+= Introduction =
+
+By default XMPP is as reliable as your network is. Unfortunately in some cases that is not very reliable - in some network conditions disconnects can be frequent and message loss can occur.
+
+To overcome this, XMPP has an optional extension (XEP-0198: Stream Management) which, when supported by both the client and server, can allow a client to resume a disconnected session, and prevent message loss.
+
+= Details =
+
+When using XEP-0198 both the client and the server keep a queue of the most recently sent stanzas - this is cleared when the other end acknowledges they have received the stanzas. If the client disconnects, instead of marking the user offline the server pretends the client is still online for a short (configurable) period of time. If the client reconnects within this period, any stanzas in the queue that the client did not receive are re-sent.
+
+If the client fails to reconnect before the timeout then it is marked offline as normal, and any stanzas in the queue are returned to the sender as a "recipient-unavailable" error.
+
+= Configuration =
+
+|| *Option* || *Default* || *Description* ||
+|| smacks_hibernation_time || 300 (5 minutes) || The number of seconds a disconnected session should stay alive for (to allow reconnect) ||
+
+= Compatibility =
+||0.8||Works||
+
+= TODO =
+  * Doesn't work very well with multiple virtual hosts yet (just a plugin implementation detail).
+  * Related to the above issue - reload/unload of this module may not work very well.
\ No newline at end of file