[geode] branch develop updated: GEODE-3948 Document subscription timeout multiplier

[db...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new 8ce536e  GEODE-3948 Document subscription timeout multiplier
8ce536e is described below

commit 8ce536ec2daf94d7e086871ccf13dcb0cd2b915a
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Thu Mar 1 15:49:48 2018 -0800

    GEODE-3948 Document subscription timeout multiplier
---
 .../reference/topics/client-cache.html.md.erb       | 10 ++++++++++
 .../how_the_pool_manages_connections.html.md.erb    | 21 ++++++++++++++++++---
 2 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/geode-docs/reference/topics/client-cache.html.md.erb b/geode-docs/reference/topics/client-cache.html.md.erb
index 19383e4..e04b735 100644
--- a/geode-docs/reference/topics/client-cache.html.md.erb
+++ b/geode-docs/reference/topics/client-cache.html.md.erb
@@ -257,6 +257,16 @@ Use for client caches. Defines a client's server pool used to communicate with s
 <td>Number of servers to use as backup to the primary for highly available subscription queue management. If set to 0, none are used. If set to -1, all available servers are used.</td>
 <td>0</td>
 </tr>
+<tr class="even">
+<td>subscription-timeout-multiplier</td>
+<td>Number of missing server pings that trigger timeout of a subscription feed.
+
+A value of zero (the default) disables timeouts. A value of one or more times out the server
+connection after the specified number of ping intervals have elapsed. A value of one is not
+recommended.
+</td>
+<td>0</td>
+</tr>
 <tr class="odd">
 <td>thread-local-connections</td>
 <td>Boolean specifying whether connections are sticky. True causes the connection to stick to the thread for multiple requests. False causes each connection to be returned to the pool after a request finishes. A sticky connection is returned to the pool when the thread releases it through the <code class="ph codeph">Pool</code> method <code class="ph codeph">releaseThreadLocalConnection</code>, when the <code class="ph codeph">idle-timeout</code> is reached, or when the pool is destroyed.</td>
diff --git a/geode-docs/topologies_and_comm/topology_concepts/how_the_pool_manages_connections.html.md.erb b/geode-docs/topologies_and_comm/topology_concepts/how_the_pool_manages_connections.html.md.erb
index b14f0e3..5177580 100644
--- a/geode-docs/topologies_and_comm/topology_concepts/how_the_pool_manages_connections.html.md.erb
+++ b/geode-docs/topologies_and_comm/topology_concepts/how_the_pool_manages_connections.html.md.erb
@@ -67,11 +67,26 @@ The pool closes a pool connection when one of the following occurs:
 
 When it closes a connection that a thread is using, the pool switches the thread to another server connection, opening a new one if needed.
 
-## <a id="how_the_pool_manages_connections__section_FFC261DF179843D8BE06B35964B80D69" class="no-quick-link"></a>How the Pool Manages Subscription Connections
+## <a id="how_the_pool_manages_subscription_connections" class="no-quick-link"></a>How the Pool Manages Subscription Connections
 
-The pool’s subscription connection is established in the same way as the pool connections, by requesting server information from the locator and then sending a request to the server, or, if you are using a static server list, by connecting to the next server in the list.
+The pool’s subscription connection is established in the same way as the pool connections, by
+requesting server information from the locator and then sending a request to the server, or, if you
+are using a static server list, by connecting to the next server in the list.
 
-Subscription connections remain open for as long as needed and are not subject to the timeouts that apply to pool connections.
+The server sends ping messages once per second by a task scheduled in a timer.
+You can adjust the interval with the system property `gemfire.serverToClientPingPeriod`, specified in milliseconds.
+The server sends its ping-interval setting to the client. The client then uses this and a
+multiplier to establish a read-timeout in the cache.
+
+You can set the client property `subscription-timeout-multiplier` to enable timeout of the
+subscription feed with failover to another server.
+
+Value options include:
+ 
+- A value of zero (the default) disables timeouts.
+
+- A value of one or more times out the server connection after the specified number of ping intervals have
+elapsed. A value of one is not recommended.
 
 ## <a id="how_the_pool_manages_connections__section_6286FB8DC6564F0AA082004B447F1FC4" class="no-quick-link"></a>How the Pool Conditions Server Load
 

-- 
To stop receiving notification emails like this one, please contact
dbarnes@apache.org.