org.opends.server.replication.protocol
Class WindowProbe

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

All Implemented Interfaces:

java.io.Serializable

public class WindowProbe
extends ReplicationMessage
implements java.io.Serializable

This message is used by LDAP or Replication Server that have been out of credit for a while and want to check that the remote servers. A sending entity that is blocked because its send window is closed for a while should create such a message to check that the window closure is valid. An entity that received such a message should respond with a WindowUpdate message indicating the curent credit available.

See Also:

Serialized Form

Constructor Summary

WindowProbe()
Create a new WindowProbe message.

WindowProbe(byte[] in)
Creates a new WindowProbe 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

WindowProbe

public WindowProbe()

Create a new WindowProbe message.

WindowProbe

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

Creates a new WindowProbe from its encoded form.

Parameters:

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

Throws:

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

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.