Package io.atomix.raft.roles

Interface RaftRole

All Superinterfaces:

AutoCloseable, Managed<RaftRole>

All Known Implementing Classes:

AbstractRole, ActiveRole, CandidateRole, FollowerRole, InactiveRole, LeaderRole, PassiveRole, PromotableRole

public interface RaftRole
extends Managed<RaftRole>

Raft role interface.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AppendResponse>	onAppend(InternalAppendRequest request)	Handles an append request.
CompletableFuture<ConfigureResponse>	onConfigure(ConfigureRequest request)	Handles a configure request.
CompletableFuture<ForceConfigureResponse>	onForceConfigure(ForceConfigureRequest request)	Handles a force configure request.
CompletableFuture<InstallResponse>	onInstall(InstallRequest request)	Handles an install request.
CompletableFuture<JoinResponse>	onJoin(JoinRequest request)	Handles a request to join the cluster.
CompletableFuture<LeaveResponse>	onLeave(LeaveRequest request)	Handles a request to leave the cluster.
CompletableFuture<PollResponse>	onPoll(PollRequest request)	Handles a poll request.
CompletableFuture<ReconfigureResponse>	onReconfigure(ReconfigureRequest request)	Handles a configure request.
CompletableFuture<TransferResponse>	onTransfer(TransferRequest request)	Handles a transfer request.
CompletableFuture<VoteResponse>	onVote(VoteRequest request)	Handles a vote request.
RaftServer.Role	role()	Returns the server state type.
Either<RaftError,Void>	shouldAcceptRequest(RaftRequest request)

Methods inherited from interface io.atomix.utils.Managed

close, isRunning, start, stop

Method Details

role

RaftServer.Role role()

Returns the server state type.

Returns:

The server state type.

onConfigure

CompletableFuture<ConfigureResponse> onConfigure(ConfigureRequest request)

Handles a configure request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onInstall

CompletableFuture<InstallResponse> onInstall(InstallRequest request)

Handles an install request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onReconfigure

CompletableFuture<ReconfigureResponse> onReconfigure(ReconfigureRequest request)

Handles a configure request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onForceConfigure

CompletableFuture<ForceConfigureResponse> onForceConfigure(ForceConfigureRequest request)

Handles a force configure request. The request is never received from a leader. This is typically requested to remove a set of (unavailable) members when a quorum is not possible.

onJoin

CompletableFuture<JoinResponse> onJoin(JoinRequest request)

Handles a request to join the cluster.

onLeave

CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)

Handles a request to leave the cluster.

onTransfer

CompletableFuture<TransferResponse> onTransfer(TransferRequest request)

Handles a transfer request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onAppend

CompletableFuture<AppendResponse> onAppend(InternalAppendRequest request)

Handles an append request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onPoll

CompletableFuture<PollResponse> onPoll(PollRequest request)

Handles a poll request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onVote

CompletableFuture<VoteResponse> onVote(VoteRequest request)

Handles a vote request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

shouldAcceptRequest

Either<RaftError,Void> shouldAcceptRequest(RaftRequest request)