[][src]Module actix_raft::messages

All public facing message types.

For users of this Raft implementation, this module defines the data types of this crate's API. The RaftNetwork trait is based entirely off of these messages, and communication with the Raft actor is based entirely off of these messages and the messages in the admin module.

Structs

AppendEntriesRequest

An RPC invoked by the leader to replicate log entries (§5.3); also used as heartbeat (§5.2).

AppendEntriesResponse

An RPC response to an AppendEntriesRequest message.

ClientPayload

A payload with an entry coming from a client request.

ConflictOpt

A struct used to implement the conflicting term optimization outlined in §5.3 for log replication.

Entry

A Raft log entry.

EntryConfigChange

A log entry holding a config change.

EntryNormal

A normal log entry.

EntrySnapshotPointer

A log entry pointing to a snapshot.

InstallSnapshotRequest

Invoked by the Raft leader to send chunks of a snapshot to a follower (§7).

InstallSnapshotResponse

An RPC response to an InstallSnapshotResponse message.

MembershipConfig

A model of the membership configuration of the cluster.

VoteRequest

An RPC invoked by candidates to gather votes (§5.2).

VoteResponse

An RPC response to an VoteResponse message.

Enums

ClientError

Error variants which may arise while handling client requests.

ClientPayloadResponse

A response to a client payload proposed to the Raft system.

EntryPayload

Log entry payload variants.

ResponseMode

The desired response mode for a client request.