From 86feff6f58da59739d4823ea616bd7f4916b8834 Mon Sep 17 00:00:00 2001
From: pero <pero@13f79535-47bb-0310-9956-ffa450edef68>
Date: Thu, 26 Apr 2007 21:09:41 +0000
Subject: [PATCH] Add heartbeatBackgroundEnabled to enable channel heartbeat
 call. Don't forget to disable the GroupChannel heartbeat thread. Default is
 false.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk@532865 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/catalina/ha/tcp/SimpleTcpCluster.java   | 31 +++++++++++++++++++---
 .../apache/catalina/ha/tcp/mbeans-descriptors.xml  | 20 +++++---------
 webapps/docs/changelog.xml                         | 10 +++++++
 webapps/docs/config/cluster.xml                    |  5 ++++
 4 files changed, 49 insertions(+), 17 deletions(-)

diff --git a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
index 3da502383..6673ab35f 100644
--- a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
+++ b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
@@ -126,6 +126,12 @@ public class SimpleTcpCluster
     protected String clusterName ;
 
     /**
+     * call Channel.heartbeat() at container background thread
+     * @see org.apache.catalina.tribes.group.GroupChannel#heartbeat()
+     */
+    protected boolean heartbeatBackgroundEnabled =false ;
+    
+    /**
      * The Container associated with this Cluster.
      */
     protected Container container = null;
@@ -188,6 +194,22 @@ public class SimpleTcpCluster
     }
 
     /**
+     * Return heartbeat enable flag (default false)
+     * @return the heartbeatBackgroundEnabled
+     */
+    public boolean isHeartbeatBackgroundEnabled() {
+        return heartbeatBackgroundEnabled;
+    }
+
+    /**
+     * enabled that container backgroundThread call heartbeat at channel
+     * @param heartbeatBackgroundEnabled the heartbeatBackgroundEnabled to set
+     */
+    public void setHeartbeatBackgroundEnabled(boolean heartbeatBackgroundEnabled) {
+        this.heartbeatBackgroundEnabled = heartbeatBackgroundEnabled;
+    }
+
+    /**
      * Set the name of the cluster to join, if no cluster with this name is
      * present create one.
      * 
@@ -584,12 +606,15 @@ public class SimpleTcpCluster
      * invoked inside the classloading context of this container. Unexpected
      * throwables will be caught and logged.
      * @see org.apache.catalina.ha.deploy.FarmWarDeployer#backgroundProcess()
-     * @see ReplicationTransmitter#backgroundProcess()
+     * @see org.apache.catalina.tribes.group.GroupChannel#heartbeat()
+     * @see org.apache.catalina.tribes.group.GroupChannel.HeartbeatThread#run()
+     * 
      */
     public void backgroundProcess() {
         if (clusterDeployer != null) clusterDeployer.backgroundProcess();
-        //send a heartbeat through the channel
-        if ( channel !=null ) channel.heartbeat();
+       
+        //send a heartbeat through the channel        
+        if ( isHeartbeatBackgroundEnabled() && channel !=null ) channel.heartbeat();
     }
 
     /**
diff --git a/java/org/apache/catalina/ha/tcp/mbeans-descriptors.xml b/java/org/apache/catalina/ha/tcp/mbeans-descriptors.xml
index ac0414079..e051aee3e 100644
--- a/java/org/apache/catalina/ha/tcp/mbeans-descriptors.xml
+++ b/java/org/apache/catalina/ha/tcp/mbeans-descriptors.xml
@@ -16,8 +16,12 @@
     <attribute   name="notifyLifecycleListenerOnFailure"
           description="notify lifecycleListener from message transfer failure"
 			     is="true"
-                 type="boolean"/>                 
-    <attribute   name="clusterName"
+                 type="boolean"/>  
+    <attribute   name="heartbeatBackgroundEnabled"
+          description="enable that container background thread call channel heartbeat, default is that channel mangage heartbeat itself."
+			     is="true"
+                 type="boolean"/>  
+     <attribute   name="clusterName"
           description="name of cluster"
                  type="java.lang.String"/>
     <attribute   name="managerClassName"
@@ -60,18 +64,6 @@
                  type="org.apache.catalina.ha.ClusterMessage"/>
     </operation>
         
-    <operation   name="sendToMember"
-               description="send message to one cluster member"
-               impact="ACTION"
-               returnType="void">
-      <parameter name="message"
-                 description="replication message"
-                 type="org.apache.catalina..cluster.ClusterMessage"/>
-      <parameter name="member"
-                 description="cluster member"
-                 type="java.lang.String"/>
-    </operation>
-
     <operation   name="start"
                description="Start the cluster"
                impact="ACTION"
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 68b88d353..2b2c3fa25 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -14,6 +14,16 @@
   </properties>
 
 <body>
+<section name="Tomcat 6.0.13 (remm)">
+  <subsection name="Cluster">
+    <changelog>
+      <fix>
+         Add heartbeatBackgroundEnabled flag to SimpleTcpCluster. 
+         Enable this flag don't forget to disable the channel heartbeat thread (pero)
+      </fix>
+    </changelog>
+  </subsection>
+</section>
 <section name="Tomcat 6.0.12 (remm)">
   <subsection name="General">
     <changelog>
diff --git a/webapps/docs/config/cluster.xml b/webapps/docs/config/cluster.xml
index 5a1622022..e4451f58c 100644
--- a/webapps/docs/config/cluster.xml
+++ b/webapps/docs/config/cluster.xml
@@ -109,6 +109,11 @@
       </p>
     </attribute>
 
+    <attribute name="heartbeatBackgroundEnabled" required="false">
+      <p>Enable this flag don't forget to disable the channel heartbeat thread.
+      </p>
+    </attribute>
+ 
     <attribute name="doClusterLog" required="false">
       <p><b>Deprecated since 6.0.0</b></p>
       <p>Possible values are <code>true</code> or <code>false</code><br/>
-- 
2.11.0