summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHolger Weiss <holger@zedat.fu-berlin.de>2014-09-16 22:42:34 +0200
committerHolger Weiss <holger@zedat.fu-berlin.de>2014-09-16 22:42:34 +0200
commit0a9212583dd59535432a10e88aeaec097ae1bd0a (patch)
treeebb48393b2025f03c61286874203755d6d1f6c59 /doc
parentMerge pull request #299 from sjmackenzie/processone (diff)
XEP-0198: Support "resend_on_timeout: if_offline"
If "resend_on_timeout" is set to "if_offline", resend unacknowledged stanzas only if no other resource is online when the session times out. In other words, allow for sending them to offline storage, but nowhere else.
Diffstat (limited to 'doc')
-rw-r--r--doc/guide.tex10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/guide.tex b/doc/guide.tex
index 27fcfc18..efebc252 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -1022,7 +1022,7 @@ request_handlers:
/"a"/"b": mod_foo
/"http-bind": mod_http_bind
\end{verbatim}
- \titem{resend\_on\_timeout: true|false}
+ \titem{resend\_on\_timeout: true|false|if\_offline}
If \term{stream\_management} is enabled and this option is set to
\term{true}, any stanzas that weren't acknowledged by the client
will be resent on session timeout. This behavior might often be
@@ -1030,8 +1030,12 @@ request_handlers:
circumstances. For example, a message that was sent to two resources
might get resent to one of them if the other one timed out.
Therefore, the default value for this option is \term{false}, which
- tells ejabberd to generate an error message instead. The option can
- be specified for \term{ejabberd\_c2s} listeners.
+ tells ejabberd to generate an error message instead. As an
+ alternative, the option may be set to \term{if\_offline}. In this
+ case, unacknowledged stanzas are resent only if no other resource is
+ online when the session times out. Otherwise, error messages are
+ generated. The option can be specified for \term{ejabberd\_c2s}
+ listeners.
\titem{resume\_timeout: Seconds}
This option configures the number of seconds until a session times
out if the connection is lost. During this period of time, a client