WindowProbeMsg (OpenDJ Public API Javadoc 7.2.5-20240524201627-49403efab3a3556b93d8ee62f263ca29a7e752ef Documentation)

java.lang.Object
- org.opends.server.replication.protocol.ReplicationMsg
- - org.opends.server.replication.protocol.WindowProbeMsg

```
public final class WindowProbeMsg
extends ReplicationMsg
```
This message is used by LDAP or Replication Server that have been out of credit for a while and want to check if the remote servers is able to accept more messages.
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 WindowMsg indicating the current credit available.

Field Summary
- Fields inherited from class org.opends.server.replication.protocol.ReplicationMsg
  COMPACT_MASK, COMPACT_TYPE_ADD, COMPACT_TYPE_DELETE, COMPACT_TYPE_MODIFY, COMPACT_TYPE_MODIFY_DN, COMPACT_TYPE_REPLICA_OFFLINE, MSG_TYPE_DISK_ENCODING

Constructor Summary

Constructors
Constructor Description

WindowProbeMsg()
Create a new WindowProbeMsg message.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`getBytes(short protocolVersion)`	Serializes the PDU using the provided replication protocol version.

Methods inherited from class org.opends.server.replication.protocol.ReplicationMsg
decodeMsg, isRetryable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WindowProbeMsg
```
public WindowProbeMsg()
```
    Create a new WindowProbeMsg message.
  - WindowProbeMsg
```
public WindowProbeMsg(byte[] in)
               throws DataFormatException
```
    Creates a new WindowProbeMsg from its encoded form.
    
    Parameters:
    
    in - The byte array containing the encoded form of the WindowMessage.
    
    Throws:
    
    DataFormatException - If the byte array does not contain a valid encoded form of the WindowMessage.
- Method Detail
  - getBytes
```
public byte[] getBytes(short protocolVersion)
```
    Description copied from class: ReplicationMsg
    
    Serializes the PDU using the provided replication protocol version. WARNING: should be overwritten by a PDU (sub class) we want to support older protocol version serialization for.
    
    Specified by:
    
    getBytes in class ReplicationMsg
    
    Parameters:
    
    protocolVersion - The protocol version to use for serialization. The version should normally be older than the current one.
    
    Returns:
    
    The encoded PDU, or null if the message isn't supported in that protocol version.