io.atomix.protocols.raft.protocol

Class InstallRequest

java.lang.Object

io.atomix.protocols.raft.protocol.AbstractRaftRequest

io.atomix.protocols.raft.protocol.InstallRequest

All Implemented Interfaces:

RaftMessage, RaftRequest

public class InstallRequest
extends AbstractRaftRequest

Server snapshot installation request.

Snapshot installation requests are sent by the leader to a follower when the follower indicates that its log is further behind than the last snapshot taken by the leader. Snapshots are sent in chunks, with each chunk being sent in a separate install request. As requests are received by the follower, the snapshot is reconstructed based on the provided chunkOffset() and other metadata. The last install request will be sent with complete() being true to indicate that all chunks of the snapshot have been sent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstallRequest.Builder Snapshot request builder.

Constructor Summary

Constructors

Constructor and Description
InstallRequest(long term, MemberId leader, long serviceId, String serviceName, long index, long timestamp, int offset, byte[] data, boolean complete)

Method Summary

Modifier and Type	Method and Description
int	chunkOffset() Returns the offset of the snapshot chunk.
boolean	complete() Returns a boolean value indicating whether this is the last chunk of the snapshot.
byte[]	data() Returns the snapshot data.
boolean	equals(Object object)
int	hashCode()
MemberId	leader() Returns the requesting leader address.
static InstallRequest.Builder	newBuilder() Returns a new install request builder.
long	serviceId() Returns the snapshot identifier.
String	serviceName() Returns the service name.
long	snapshotIndex() Returns the snapshot index.
long	snapshotTimestamp() Returns the snapshot timestamp.
long	term() Returns the requesting node's current term.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstallRequest

public InstallRequest(long term,
                      MemberId leader,
                      long serviceId,
                      String serviceName,
                      long index,
                      long timestamp,
                      int offset,
                      byte[] data,
                      boolean complete)

Method Detail

newBuilder

public static InstallRequest.Builder newBuilder()

Returns a new install request builder.

Returns:

A new install request builder.

term

public long term()

Returns the requesting node's current term.

Returns:

The requesting node's current term.

leader

public MemberId leader()

Returns the requesting leader address.

Returns:

The leader's address.

serviceId

public long serviceId()

Returns the snapshot identifier.

Returns:

The snapshot identifier.

serviceName

public String serviceName()

Returns the service name.

Returns:

The service name.

snapshotIndex

public long snapshotIndex()

Returns the snapshot index.

Returns:

The snapshot index.

snapshotTimestamp

public long snapshotTimestamp()

Returns the snapshot timestamp.

Returns:

The snapshot timestamp.

chunkOffset

public int chunkOffset()

Returns the offset of the snapshot chunk.

Returns:

The offset of the snapshot chunk.

data

public byte[] data()

Returns the snapshot data.

Returns:

The snapshot data.

complete

public boolean complete()

Returns a boolean value indicating whether this is the last chunk of the snapshot.

Returns:

Indicates whether this request is the last chunk of the snapshot.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object