io.atomix.protocols.raft.protocol

Class PublishRequest

java.lang.Object

io.atomix.protocols.raft.protocol.AbstractRaftRequest

io.atomix.protocols.raft.protocol.SessionRequest

io.atomix.protocols.raft.protocol.PublishRequest

All Implemented Interfaces:

RaftMessage, RaftRequest

public class PublishRequest
extends SessionRequest

Event publish request.

Publish requests are used by servers to publish event messages to clients. Event messages are sequenced based on the point in the Raft log at which they were published to the client. The eventIndex() indicates the index at which the event was sent, and the previousIndex() indicates the index of the prior event messages sent to the client. Clients must ensure that event messages are received in sequence by tracking the last index for which they received an event message and validating previousIndex() against that index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublishRequest.Builder Publish request builder.

Constructor Summary

Constructors

Constructor and Description
PublishRequest(long session, long eventIndex, long previousIndex, List<RaftEvent> events)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
long	eventIndex() Returns the event index.
List<RaftEvent>	events() Returns the request events.
int	hashCode()
static PublishRequest.Builder	newBuilder() Returns a new publish request builder.
long	previousIndex() Returns the previous event index.
String	toString()

Methods inherited from class io.atomix.protocols.raft.protocol.SessionRequest

session

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PublishRequest

public PublishRequest(long session,
                      long eventIndex,
                      long previousIndex,
                      List<RaftEvent> events)

Method Detail

newBuilder

public static PublishRequest.Builder newBuilder()

Returns a new publish request builder.

Returns:

A new publish request builder.

eventIndex

public long eventIndex()

Returns the event index.

Returns:

The event index.

previousIndex

public long previousIndex()

Returns the previous event index.

Returns:

The previous event index.

events

public List<RaftEvent> events()

Returns the request events.

Returns:

The request events.

hashCode

public int hashCode()

Overrides:

hashCode in class SessionRequest

equals

public boolean equals(Object object)

Overrides:

equals in class SessionRequest

toString

public String toString()

Overrides:

toString in class SessionRequest