org.opends.server.replication.protocol
Class HeartbeatMessage

java.lang.Object
  org.opends.server.replication.protocol.ReplicationMessage
      org.opends.server.replication.protocol.HeartbeatMessage

public class HeartbeatMessage
extends ReplicationMessage

This message is sent at regular intervals by the replication server when it is sending no other messages. It allows the directory server to detect a problem sooner when a synchronization server has crashed or has been isolated from the network.

Constructor Summary

HeartbeatMessage()
Create a new HeartbeatMessage.

HeartbeatMessage(byte[] in)
Creates a new heartbeat message from its encoded form.

Method Summary

byte[]

getBytes() Return the byte[] representation of this message.

Methods inherited from class org.opends.server.replication.protocol.ReplicationMessage

addByteArray, generateMsg, getNextLength

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatMessage

public HeartbeatMessage()

Create a new HeartbeatMessage.

HeartbeatMessage

public HeartbeatMessage(byte[] in)
                 throws java.util.zip.DataFormatException

Creates a new heartbeat message from its encoded form.

Parameters:

in - The byte array containing the encoded form of the message.

Throws:

java.util.zip.DataFormatException - If the byte array does not contain a valid encoded form of the message.

Method Detail

getBytes

public byte[] getBytes()

Return the byte[] representation of this message. Depending on the message type, the first byte of the byte[] must be. MSG_TYPE_MODIFY_REQUEST MSG_TYPE_ADD_REQUEST MSG_TYPE_DELETE_REQUEST MSG_TYPE_MODIFY_DN_REQUEST MSG_TYPE_ACK MSG_TYPE_SERVER_START MSG_TYPE_REPL_SERVER_START MSG_TYPE_WINDOW MSG_TYPE_HEARTBEAT MSG_TYPE_INITIALIZE MSG_TYPE_INITIALIZE_TARGET MSG_TYPE_ENTRY MSG_TYPE_DONE MSG_TYPE_ERROR MSG_TYPE_WINDOW_PROBE MSG_TYPE_REPL_SERVER_INFO MSG_TYPE_RESET_GENERATION_ID MSG_TYPE_REPL_SERVER_MONITOR_REQUEST MSG_TYPE_REPL_SERVER_MONITOR

Specified by:

getBytes in class ReplicationMessage

Returns:

the byte[] representation of this message.