Package io.atomix.raft.roles

Class CandidateRole

java.lang.Object

io.atomix.raft.roles.AbstractRole

io.atomix.raft.roles.InactiveRole

io.atomix.raft.roles.PassiveRole

io.atomix.raft.roles.ActiveRole

io.atomix.raft.roles.CandidateRole

All Implemented Interfaces:

RaftRole, Managed<RaftRole>

public final class CandidateRole
extends ActiveRole

Candidate state.

Field Summary

Fields inherited from class io.atomix.raft.roles.AbstractRole

log, raft

Constructor Summary

Constructors

Constructor	Description
CandidateRole(RaftContext context)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AppendResponse>	onAppend(AppendRequest request)	Handles an append request.
CompletableFuture<VoteResponse>	onVote(VoteRequest request)	Handles a vote request.
RaftServer.Role	role()	Returns the Raft state represented by this state.
CompletableFuture<RaftRole>	start()
CompletableFuture<Void>	stop()

Methods inherited from class io.atomix.raft.roles.ActiveRole

handlePoll, handleVote, onPoll

Methods inherited from class io.atomix.raft.roles.PassiveRole

appendEntries, checkPreviousEntry, checkTerm, completeAppend, failAppend, handleAppend, onInstall, onReconfigure, succeedAppend

Methods inherited from class io.atomix.raft.roles.InactiveRole

onConfigure, onTransfer

Methods inherited from class io.atomix.raft.roles.AbstractRole

forward, isRunning, logRequest, logResponse, toString, updateTermAndLeader

Methods inherited from class java.lang.Object

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

Constructor Details

CandidateRole

public CandidateRole(RaftContext context)

Method Details

start

public CompletableFuture<RaftRole> start()

Specified by:

start in interface Managed<RaftRole>

Overrides:

start in class PassiveRole

stop

public CompletableFuture<Void> stop()

Specified by:

stop in interface Managed<RaftRole>

Overrides:

stop in class PassiveRole

role

public RaftServer.Role role()

Description copied from class: AbstractRole

Returns the Raft state represented by this state.

Specified by:

role in interface RaftRole

Overrides:

role in class PassiveRole

Returns:

The Raft state represented by this state.

onAppend

public CompletableFuture<AppendResponse> onAppend(AppendRequest request)

Description copied from interface: RaftRole

Handles an append request.

Specified by:

onAppend in interface RaftRole

Overrides:

onAppend in class ActiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onVote

public CompletableFuture<VoteResponse> onVote(VoteRequest request)

Description copied from interface: RaftRole

Handles a vote request.

Specified by:

onVote in interface RaftRole

Overrides:

onVote in class ActiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.