org.opends.server.replication.protocol
Class HeartbeatThread

java.lang.Object
  java.lang.Thread
      org.opends.server.api.DirectoryThread
          org.opends.server.replication.protocol.HeartbeatThread

All Implemented Interfaces:

java.lang.Runnable

public class HeartbeatThread
extends DirectoryThread

This thread publishes a heartbeat message on a given protocol session at regular intervals when there are no other replication messages being published.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

HeartbeatThread(java.lang.String threadName, ProtocolSession session, long heartbeatInterval)
Create a heartbeat thread.

Method Summary

void	run()
static void	setHeartbeatsDisabled(boolean heartbeatsDisabled) For testing purposes only to simulate loss of heartbeats.
void	shutdown() Call this method to stop the thread.

Methods inherited from class org.opends.server.api.DirectoryThread

getAssociatedTask, getCreationStackTrace, getDebugProperties, getParentThread, setAssociatedTask

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HeartbeatThread

public HeartbeatThread(java.lang.String threadName,
                       ProtocolSession session,
                       long heartbeatInterval)

Create a heartbeat thread.

Parameters:

threadName - The name of the heartbeat thread.

session - The session on which heartbeats are to be sent.

heartbeatInterval - The desired interval between heartbeats in milliseconds.

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

shutdown

public void shutdown()

Call this method to stop the thread. This method is blocking until the thread has stopped.

setHeartbeatsDisabled

public static void setHeartbeatsDisabled(boolean heartbeatsDisabled)

For testing purposes only to simulate loss of heartbeats.

Parameters:

heartbeatsDisabled - Set true to prevent heartbeats from being sent.