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

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

```
public final class StopMsg
extends ReplicationMsg
```
This message is part of the replication protocol. This message is sent by a server to tell a peer the communication will be terminated.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StopMsg.StopReason
The reason why the connection might be terminated.

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
`StopMsg()`	Creates a message.
`StopMsg(byte[] in)`	Creates a new message by decoding the provided byte array.
`StopMsg(StopMsg.StopReason reason)`	Creates a new message with the provided reason.

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.
`StopMsg.StopReason`	`getReason()`	Returns the reason for stopping sent by the peer.
`String`	`toString()`

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, wait, wait, wait

- Constructor Detail
  - StopMsg
```
public StopMsg()
```
    Creates a message.
  - StopMsg
```
public StopMsg(byte[] in)
```
    Creates a new message by decoding the provided byte array.
    
    Parameters:
    
    in - A byte array containing the encoded information for the message,
  - StopMsg
```
public StopMsg(StopMsg.StopReason reason)
```
    Creates a new message with the provided reason.
    
    Parameters:
    
    reason - the reason to be sent to the peer
- Method Detail
  - getReason
```
public StopMsg.StopReason getReason()
```
    Returns the reason for stopping sent by the peer.
    
    Returns:
    
    the reason for stopping sent by the peer
  - 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object