com.hazelcast.cp.internal.raft.impl.dto

Class AppendRequest

java.lang.Object

com.hazelcast.cp.internal.raft.impl.dto.AppendRequest

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable

public class AppendRequest
extends Object
implements IdentifiedDataSerializable

Struct for AppendEntries RPC.

See 5.3 Log replication section of In Search of an Understandable Consensus Algorithm paper by Diego Ongaro and John Ousterhout.

Invoked by leader to replicate log entries (§5.3); also used as heartbeat (§5.2).

Constructor Summary

Constructors

Constructor and Description
AppendRequest()
AppendRequest(Endpoint leader, int term, int prevLogTerm, long prevLogIndex, long leaderCommitIndex, LogEntry[] entries)

Method Summary

Modifier and Type	Method and Description
LogEntry[]	entries()
int	entryCount()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
Endpoint	leader()
long	leaderCommitIndex()
long	prevLogIndex()
int	prevLogTerm()
void	readData(ObjectDataInput in) Reads fields from the input stream
int	term()
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AppendRequest

public AppendRequest()

AppendRequest

public AppendRequest(Endpoint leader,
                     int term,
                     int prevLogTerm,
                     long prevLogIndex,
                     long leaderCommitIndex,
                     LogEntry[] entries)

Method Detail

leader

public Endpoint leader()

term

public int term()

prevLogTerm

public int prevLogTerm()

prevLogIndex

public long prevLogIndex()

leaderCommitIndex

public long leaderCommitIndex()

entries

public LogEntry[] entries()

entryCount

public int entryCount()

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

toString

public String toString()

Overrides:

toString in class Object