Payload (controller-docs 4.0.13 API)

java.lang.Object
- org.opendaylight.controller.cluster.raft.messages.Payload

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IdentifiablePayload, NoopPayload, ServerConfigurationPayload
```
public abstract class Payload
extends Object
implements Serializable
```
An instance of a Payload class is meant to be used as the Payload for AppendEntries.
When an actor which is derived from RaftActor attempts to persistData it must pass an instance of the Payload class. Similarly when state needs to be applied to the derived RaftActor it will be passed an instance of the Payload class.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Payload()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract int`	`size()`	Return the estimate of in-memory size of this payload.
`protected abstract Object`	`writeReplace()`	Return the serialization proxy for this object.

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

- Constructor Detail
  - Payload
```
public Payload()
```
- Method Detail
  - size
```
public abstract int size()
```
    Return the estimate of in-memory size of this payload.
    
    Returns:
    
    An estimate of the in-memory size of this payload.
  - writeReplace
```
protected abstract Object writeReplace()
```
    Return the serialization proxy for this object.
    
    Returns:
    
    Serialization proxy