Package io.microraft.model

Interface RaftModelFactory

public interface RaftModelFactory

Used for creating RaftModel objects with the builder pattern.

Users of MicroRaft can provide an implementation of this interface while creating RaftNode instances. Otherwise, DefaultRaftModelFactory is used. RaftModel objects created by a Raft model factory implementation are passed to Transport for networking, and RaftStore for persistence.

A RaftModelFactory implementation can implement RaftNodeLifecycleAware to perform initialization and clean up work during RaftNode startup and termination. RaftNode calls RaftNodeLifecycleAware.onRaftNodeStart() before calling any other method on RaftModelFactory, and finally calls RaftNodeLifecycleAware.onRaftNodeTerminate() on termination.

Method Summary

Modifier and Type	Method	Description
AppendEntriesFailureResponse.AppendEntriesFailureResponseBuilder	createAppendEntriesFailureResponseBuilder()
AppendEntriesRequest.AppendEntriesRequestBuilder	createAppendEntriesRequestBuilder()
AppendEntriesSuccessResponse.AppendEntriesSuccessResponseBuilder	createAppendEntriesSuccessResponseBuilder()
InstallSnapshotRequest.InstallSnapshotRequestBuilder	createInstallSnapshotRequestBuilder()
InstallSnapshotResponse.InstallSnapshotResponseBuilder	createInstallSnapshotResponseBuilder()
LogEntry.LogEntryBuilder	createLogEntryBuilder()
PreVoteRequest.PreVoteRequestBuilder	createPreVoteRequestBuilder()
PreVoteResponse.PreVoteResponseBuilder	createPreVoteResponseBuilder()
RaftGroupMembersView.RaftGroupMembersViewBuilder	createRaftGroupMembersViewBuilder()
SnapshotChunk.SnapshotChunkBuilder	createSnapshotChunkBuilder()
SnapshotEntry.SnapshotEntryBuilder	createSnapshotEntryBuilder()
TriggerLeaderElectionRequest.TriggerLeaderElectionRequestBuilder	createTriggerLeaderElectionRequestBuilder()
UpdateRaftGroupMembersOp.UpdateRaftGroupMembersOpBuilder	createUpdateRaftGroupMembersOpBuilder()
VoteRequest.VoteRequestBuilder	createVoteRequestBuilder()
VoteResponse.VoteResponseBuilder	createVoteResponseBuilder()

Method Detail

createLogEntryBuilder

@Nonnull
LogEntry.LogEntryBuilder createLogEntryBuilder()

createSnapshotEntryBuilder

@Nonnull
SnapshotEntry.SnapshotEntryBuilder createSnapshotEntryBuilder()

createSnapshotChunkBuilder

@Nonnull
SnapshotChunk.SnapshotChunkBuilder createSnapshotChunkBuilder()

createAppendEntriesRequestBuilder

@Nonnull
AppendEntriesRequest.AppendEntriesRequestBuilder createAppendEntriesRequestBuilder()

createAppendEntriesSuccessResponseBuilder

@Nonnull
AppendEntriesSuccessResponse.AppendEntriesSuccessResponseBuilder createAppendEntriesSuccessResponseBuilder()

createAppendEntriesFailureResponseBuilder

@Nonnull
AppendEntriesFailureResponse.AppendEntriesFailureResponseBuilder createAppendEntriesFailureResponseBuilder()

createInstallSnapshotRequestBuilder

@Nonnull
InstallSnapshotRequest.InstallSnapshotRequestBuilder createInstallSnapshotRequestBuilder()

createInstallSnapshotResponseBuilder

@Nonnull
InstallSnapshotResponse.InstallSnapshotResponseBuilder createInstallSnapshotResponseBuilder()

createPreVoteRequestBuilder

@Nonnull
PreVoteRequest.PreVoteRequestBuilder createPreVoteRequestBuilder()

createPreVoteResponseBuilder

@Nonnull
PreVoteResponse.PreVoteResponseBuilder createPreVoteResponseBuilder()

createTriggerLeaderElectionRequestBuilder

@Nonnull
TriggerLeaderElectionRequest.TriggerLeaderElectionRequestBuilder createTriggerLeaderElectionRequestBuilder()

createVoteRequestBuilder

@Nonnull
VoteRequest.VoteRequestBuilder createVoteRequestBuilder()

createVoteResponseBuilder

@Nonnull
VoteResponse.VoteResponseBuilder createVoteResponseBuilder()

createUpdateRaftGroupMembersOpBuilder

@Nonnull
UpdateRaftGroupMembersOp.UpdateRaftGroupMembersOpBuilder createUpdateRaftGroupMembersOpBuilder()

createRaftGroupMembersViewBuilder

@Nonnull
RaftGroupMembersView.RaftGroupMembersViewBuilder createRaftGroupMembersViewBuilder()