From 3f6fbba325443b013aa525e80e1d859e44fdd34d Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Wed, 18 Sep 2013 16:20:14 +0000
Subject: [PATCH] Fix OPENDJ-1058 – HeartbeatConnectionFactory does not actively shutdown dead connections
---
opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml | 18 ++++++++++++++++--
opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml | 6 ++++++
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml b/opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml
index ce534dc..b6ea06b 100644
--- a/opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml
+++ b/opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml
@@ -77,15 +77,21 @@
<listitem><para><literal>org.forgerock.opendj.ldap.schema.SyntaxImpl</literal></para></listitem>
</itemizedlist>
+ </listitem>
+
+ <listitem>
<para>The following methods are Deprecated.</para>
<itemizedlist>
+ <listitem><para><literal>org.forgerock.opendj.ldap.Connections#newHeartBeatConnectionFactory</literal></para></listitem>
<listitem><para><literal>org.forgerock.opendj.ldap.LDAPListenerOptions#getTCPNIOTransport</literal></para></listitem>
<listitem><para><literal>org.forgerock.opendj.ldap.LDAPListenerOptions#setTCPNIOTransport</literal></para></listitem>
<listitem><para><literal>org.forgerock.opendj.ldap.LDAPOptions#getTCPNIOTransport</literal></para></listitem>
<listitem><para><literal>org.forgerock.opendj.ldap.LDAPOptions#setTCPNIOTransport</literal></para></listitem>
</itemizedlist>
+ </listitem>
+ <listitem>
<para>The class <literal>org.forgerock.opendj.ldap.CoreMessages</literal> is
Internal.</para>
</listitem>
diff --git a/opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml b/opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
index bf1efc1..47fa9ba 100644
--- a/opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
+++ b/opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
@@ -134,8 +134,10 @@
<term>"heartBeatIntervalSeconds" (optional)</term>
<listitem>
<para>The gateway tests its connections every
- <literal>heartBeatIntervalSeconds</literal> seconds to detect whether
- the connection is still alive.</para>
+ <literal>heartBeatIntervalSeconds</literal> to detect whether
+ the connection is still alive. The first test is performed
+ immediately when the gateway gets a connection. Subsequent tests
+ follow every <literal>heartBeatIntervalSeconds</literal>.</para>
<para>Default: 30 (seconds)</para>
@@ -144,6 +146,18 @@
</varlistentry>
<varlistentry>
+ <term>"heartBeatTimeoutMilliSeconds" (optional)</term>
+ <listitem>
+ <para>When the gateway tests a connection, if the heartbeat does not come back after
+ <literal>heartBeatTimeoutMilliSeconds</literal> the connection is marked as closed.</para>
+
+ <para>Default: 500 (milliseconds)</para>
+
+ <programlisting language="javascript">"heartBeatTimeoutMilliSeconds": 500</programlisting>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>"fileBasedTrustManagerFile" (optional)</term>
<listitem>
<para>If "trustManager" is set to "file", then this setting
--
Gitblit v1.10.0