ReplicationPayloadDescriptor (Elara Event Sourcing)

java.lang.Object
- java.lang.Enum<ReplicationPayloadDescriptor>
- - org.tools4j.elara.plugin.replication.ReplicationPayloadDescriptor

All Implemented Interfaces:: Serializable, Comparable<ReplicationPayloadDescriptor>

public enum ReplicationPayloadDescriptor
extends Enum<ReplicationPayloadDescriptor>

Descriptor of payload layout for replication commands and events in a byte buffer.


     0         1         2         3         4         5         6
     0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |Version| Flags |     Type      |      Payload Size = 0         |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |      Candidate/Leader ID      |             Term              |
     +-------+-------+-------+-------+-------+-------+-------+-------+

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANDIDATE_ID_LENGTH`
`static int`	`CANDIDATE_ID_OFFSET`
`static int`	`FLAGS_LENGTH`
`static byte`	`FLAGS_NONE`
`static int`	`FLAGS_OFFSET`
`static int`	`LEADER_ID_LENGTH`
`static int`	`LEADER_ID_OFFSET`
`static int`	`PAYLOAD_LENGTH`
`static int`	`PAYLOAD_SIZE_LENGTH`
`static int`	`PAYLOAD_SIZE_OFFSET`
`static int`	`TERM_LENGTH`
`static int`	`TERM_OFFSET`
`static int`	`TYPE_LENGTH`
`static int`	`TYPE_OFFSET`
`static byte`	`VERSION`
`static int`	`VERSION_LENGTH`
`static int`	`VERSION_OFFSET`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`candidateId(DirectBuffer payload)`
`static byte`	`flags(DirectBuffer payload)`
`static int`	`leaderId(DirectBuffer payload)`
`static int`	`payloadSize(DirectBuffer payload)`
`static int`	`term(DirectBuffer payload)`
`static int`	`type(DirectBuffer payload)`
`static ReplicationPayloadDescriptor`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ReplicationPayloadDescriptor[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static byte`	`version(DirectBuffer payload)`

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERSION
```
public static final byte VERSION
```
    See Also:
    
    Constant Field Values
  - FLAGS_NONE
```
public static final byte FLAGS_NONE
```
    See Also:
    
    Constant Field Values
  - VERSION_OFFSET
```
public static final int VERSION_OFFSET
```
    See Also:
    
    Constant Field Values
  - VERSION_LENGTH
```
public static final int VERSION_LENGTH
```
    See Also:
    
    Constant Field Values
  - FLAGS_OFFSET
```
public static final int FLAGS_OFFSET
```
    See Also:
    
    Constant Field Values
  - FLAGS_LENGTH
```
public static final int FLAGS_LENGTH
```
    See Also:
    
    Constant Field Values
  - TYPE_OFFSET
```
public static final int TYPE_OFFSET
```
    See Also:
    
    Constant Field Values
  - TYPE_LENGTH
```
public static final int TYPE_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_SIZE_OFFSET
```
public static final int PAYLOAD_SIZE_OFFSET
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_SIZE_LENGTH
```
public static final int PAYLOAD_SIZE_LENGTH
```
    See Also:
    
    Constant Field Values
  - CANDIDATE_ID_OFFSET
```
public static final int CANDIDATE_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - CANDIDATE_ID_LENGTH
```
public static final int CANDIDATE_ID_LENGTH
```
    See Also:
    
    Constant Field Values
  - TERM_OFFSET
```
public static final int TERM_OFFSET
```
    See Also:
    
    Constant Field Values
  - TERM_LENGTH
```
public static final int TERM_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_LENGTH
```
public static final int PAYLOAD_LENGTH
```
    See Also:
    
    Constant Field Values
  - LEADER_ID_OFFSET
```
public static final int LEADER_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - LEADER_ID_LENGTH
```
public static final int LEADER_ID_LENGTH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static ReplicationPayloadDescriptor[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ReplicationPayloadDescriptor c : ReplicationPayloadDescriptor.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ReplicationPayloadDescriptor valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - version
```
public static byte version(DirectBuffer payload)
```
  - flags
```
public static byte flags(DirectBuffer payload)
```
  - type
```
public static int type(DirectBuffer payload)
```
  - payloadSize
```
public static int payloadSize(DirectBuffer payload)
```
  - candidateId
```
public static int candidateId(DirectBuffer payload)
```
  - leaderId
```
public static int leaderId(DirectBuffer payload)
```
  - term
```
public static int term(DirectBuffer payload)
```

Enum ReplicationPayloadDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

VERSION

FLAGS_NONE

VERSION_OFFSET

VERSION_LENGTH

FLAGS_OFFSET

FLAGS_LENGTH

TYPE_OFFSET

TYPE_LENGTH

PAYLOAD_SIZE_OFFSET

PAYLOAD_SIZE_LENGTH

CANDIDATE_ID_OFFSET

CANDIDATE_ID_LENGTH

TERM_OFFSET

TERM_LENGTH

PAYLOAD_LENGTH

LEADER_ID_OFFSET

LEADER_ID_LENGTH

Method Detail

values

valueOf

version

flags

type

payloadSize

candidateId

leaderId

term