From 59623ab67898b30a84f961c8af08f35c6a7024f4 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Wed, 09 Oct 2013 15:07:13 +0000
Subject: [PATCH] *HeartbeatThread.java: Improved javadocs.

---
 opends/src/server/org/opends/server/replication/service/CTHeartbeatPublisherThread.java |   24 ++++++++++++------------
 1 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/opends/src/server/org/opends/server/replication/service/CTHeartbeatPublisherThread.java b/opends/src/server/org/opends/server/replication/service/CTHeartbeatPublisherThread.java
index aed93c0..80ef7a6 100644
--- a/opends/src/server/org/opends/server/replication/service/CTHeartbeatPublisherThread.java
+++ b/opends/src/server/org/opends/server/replication/service/CTHeartbeatPublisherThread.java
@@ -35,14 +35,17 @@
 import org.opends.server.replication.protocol.ChangeTimeHeartbeatMsg;
 import org.opends.server.replication.protocol.Session;
 import org.opends.server.types.DebugLogLevel;
+import org.opends.server.util.StaticUtils;
 import org.opends.server.util.TimeThread;
 
 import static org.opends.server.loggers.debug.DebugLogger.*;
 
 /**
- * This thread publishes a heartbeat message on a given protocol session at
- * regular intervals when there are no other replication messages being
- * published.
+ * This thread publishes a {@link ChangeTimeHeartbeatMsg} on a given protocol
+ * session at regular intervals when there are no other replication messages
+ * being published.
+ * <p>
+ * These heartbeat messages are sent by a replica directory server.
  */
 public class CTHeartbeatPublisherThread extends DirectoryThread
 {
@@ -102,17 +105,15 @@
       while (!shutdown)
       {
         long now = System.currentTimeMillis();
-        ChangeTimeHeartbeatMsg ctHeartbeatMsg =
-         new ChangeTimeHeartbeatMsg(
-             new CSN(TimeThread.getTime(),0, serverId));
+        final CSN csn = new CSN(TimeThread.getTime(), 0, serverId);
+        ChangeTimeHeartbeatMsg ctHeartbeatMsg = new ChangeTimeHeartbeatMsg(csn);
 
         if (now > session.getLastPublishTime() + heartbeatInterval)
         {
           session.publish(ctHeartbeatMsg);
         }
 
-        long sleepTime = session.getLastPublishTime() +
-            heartbeatInterval - now;
+        long sleepTime = session.getLastPublishTime() + heartbeatInterval - now;
         if (sleepTime <= 0)
         {
           sleepTime = heartbeatInterval;
@@ -143,16 +144,15 @@
     {
       if (debugEnabled())
       {
-        TRACER.debugInfo(getName() + "could not send a heartbeat." +
-            e.getMessage() + e);
+        TRACER.debugInfo(getName() + " could not send a heartbeat: "
+            + StaticUtils.stackTraceToString(e));
       }
-      // This will be caught in another thread.
     }
     finally
     {
       if (debugEnabled())
       {
-        TRACER.debugInfo(getName()+" is exiting.");
+        TRACER.debugInfo(getName() + " is exiting.");
       }
     }
   }

--
Gitblit v1.10.0