From d0f1300a842f5f22ec22c3387d23fef84a85020c Mon Sep 17 00:00:00 2001
From: Badlop <badlop@process-one.net>
Date: Sat, 14 Feb 2009 09:03:26 +0000
Subject: * src/web/ejabberd_http_poll.erl: Allow configuration of session
 timeout, using new global option http_poll_timeout (EJAB-135) *
 doc/guide.tex: Document new option * doc/guide.html: Likewise

SVN Revision: 1876
---
 doc/guide.html | 10 +++++++---
 doc/guide.tex  |  7 +++++++
 2 files changed, 14 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/guide.html b/doc/guide.html
index 55ce1dc69..452131d97 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -712,8 +712,11 @@ do not allow outgoing sockets on port 5222.<P>If HTTP Polling is enabled, it wil
 <CODE>http://server:port/http-poll/</CODE>. Be aware that support for HTTP Polling
 is also needed in the Jabber client. Remark also that HTTP Polling can be
 interesting to host a web-based Jabber client such as
-<A HREF="http://jwchat.sourceforge.net/">JWChat</A>.
-</P></DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description">
+<A HREF="http://jwchat.sourceforge.net/">JWChat</A>.</P><P>The maximum period of time to keep a client session active without
+an incoming POST request can be configured with the global option
+<TT>http_poll_timeout</TT>. The default value is five minutes.
+The option can be defined in <TT>ejabberd.cfg</TT>, expressing the time
+in seconds: <CODE>{http_poll_timeout, 300}.</CODE></P></DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description">
 This option specifies an
 approximate maximum size in bytes of XML stanzas. Approximate,
 because it is calculated with the precision of one block of readed
@@ -3370,7 +3373,8 @@ If a process in the <TT>ejabberd</TT> server consumes more memory than the confi
 a message is sent to the Jabber accounts defined with the option
 <TT>watchdog_admins</TT>
  in the <TT>ejabberd</TT> configuration file.</P><P>The memory consumed is measured in <TT>words</TT>:
-a word on 32-bit architecture is 4 bytes, and a word on 64-bit architecture 8 bytes.
+a word on 32-bit architecture is 4 bytes,
+and a word on 64-bit architecture is 8 bytes.
 The threshold by default is 1000000 words.
 This value can be configured with the option <TT>watchdog_large_heap</TT>,
 or in a conversation with the watchdog alert bot.</P><P>Example configuration:
diff --git a/doc/guide.tex b/doc/guide.tex
index 169dc612e..f5231affa 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -854,6 +854,13 @@ This is a detailed description of each option allowed by the listening modules:
     is also needed in the \Jabber{} client. Remark also that HTTP Polling can be
     interesting to host a web-based \Jabber{} client such as
     \footahref{http://jwchat.sourceforge.net/}{JWChat}.
+
+    The maximum period of time to keep a client session active without
+    an incoming POST request can be configured with the global option
+    \term{http\_poll\_timeout}. The default value is five minutes.
+    The option can be defined in \term{ejabberd.cfg}, expressing the time
+    in seconds: \verb|{http_poll_timeout, 300}.|
+
   \titem{\{max\_stanza\_size, Size\}}
     \ind{options!max\_stanza\_size}This option specifies an
     approximate maximum size in bytes of XML stanzas.  Approximate,
-- 
cgit v1.2.3