*HeartbeatThread.java: Improved javadocs.

Jean-Noel Rouvignac

09.07.2013 59623ab67898b30a84f961c8af08f35c6a7024f4

*HeartbeatThread.java:
Improved javadocs.

 opends/src/server/org/opends/server/replication/protocol/HeartbeatThread.java

@@ -25,21 +25,23 @@
 *      Copyright 2008 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2013 ForgeRock AS
 */

package org.opends.server.replication.protocol;

import org.opends.server.api.DirectoryThread;
import static org.opends.server.loggers.debug.DebugLogger.*;

import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.types.DebugLogLevel;

import java.io.IOException;

import org.opends.server.api.DirectoryThread;
import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.types.DebugLogLevel;
import org.opends.server.util.StaticUtils;

import static org.opends.server.loggers.debug.DebugLogger.*;

/**
 * This thread publishes a heartbeat message on a given protocol session at
 * This thread publishes a {@link HeartbeatMsg} 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 replication server.
 */
public class HeartbeatThread extends DirectoryThread
{
@@ -124,8 +126,7 @@
          }
        }

        long sleepTime = session.getLastPublishTime() +
            heartbeatInterval - now;
        long sleepTime = session.getLastPublishTime() + heartbeatInterval - now;
        if (sleepTime <= 0)
        {
          sleepTime = heartbeatInterval;
@@ -161,9 +162,9 @@
    {
      if (debugEnabled())
      {
        TRACER.debugInfo("Heartbeat thread could not send a heartbeat.");
        TRACER.debugInfo("Heartbeat thread could not send a heartbeat."
            + StaticUtils.stackTraceToString(e));
      }
      // This will be caught in another thread.
    }
    finally
    {

 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.");
      }
    }
  }