org.opends.server.replication.protocol
Class WindowMessage

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

All Implemented Interfaces:

java.io.Serializable

public class WindowMessage
extends ReplicationMessage
implements java.io.Serializable

This message is used by LDAP server or by Replication Servers to update the send window of the remote entities. A receiving entity should create such a message with a given credit when it wants to open the send window of the remote entity. A LDAP or Replication Server should increase its send window when receiving such a message.

See Also:

Serialized Form

Constructor Summary

WindowMessage(byte[] in)
Creates a new WindowMessage from its encoded form.

WindowMessage(int numAck)
Create a new WindowMessage.

Method Summary

byte[]	getBytes() Return the byte[] representation of this message.
int	getNumAck() Get the number of message acknowledged by the Window 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

WindowMessage

public WindowMessage(int numAck)

Create a new WindowMessage.

Parameters:

numAck - The number of acknowledged messages. The window will be increase by this credit number.

WindowMessage

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

Creates a new WindowMessage 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.

getNumAck

public int getNumAck()

Get the number of message acknowledged by the Window Message.

Returns:

the number of message acknowledged by the Window Message.