Package io.atomix.raft.roles

Class PassiveRole

java.lang.Object

io.atomix.raft.roles.AbstractRole

io.atomix.raft.roles.InactiveRole

io.atomix.raft.roles.PassiveRole

All Implemented Interfaces:

RaftRole, Managed<RaftRole>, AutoCloseable

Direct Known Subclasses:

ActiveRole, PromotableRole

public class PassiveRole
extends InactiveRole

Passive state.

Field Summary

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

log, raft

Constructor Summary

Constructors

Constructor	Description
PassiveRole(RaftContext context)

Method Summary

Modifier and Type	Method	Description
protected void	appendEntries(InternalAppendRequest request, CompletableFuture<AppendResponse> future)	Appends entries from the given AppendRequest.
protected boolean	checkPreviousEntry(InternalAppendRequest request, CompletableFuture<AppendResponse> future)	Checks the previous index of the given AppendRequest, returning a boolean indicating whether to continue handling the request.
protected boolean	checkTerm(InternalAppendRequest request, CompletableFuture<AppendResponse> future)	Checks the leader's term of the given AppendRequest, returning a boolean indicating whether to continue handling the request.
protected boolean	completeAppend(boolean succeeded, long lastLogIndex, CompletableFuture<AppendResponse> future)	Returns a successful append response.
protected boolean	failAppend(long lastLogIndex, CompletableFuture<AppendResponse> future)	Returns a failed append response.
protected CompletableFuture<AppendResponse>	handleAppend(InternalAppendRequest request)	Handles an AppendRequest.
CompletableFuture<AppendResponse>	onAppend(InternalAppendRequest request)	Handles an append 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<VoteResponse>	onVote(VoteRequest request)	Handles a vote request.
RaftServer.Role	role()	Returns the server state type.
CompletableFuture<RaftRole>	start()
CompletableFuture<Void>	stop()
protected boolean	succeedAppend(long lastLogIndex, CompletableFuture<AppendResponse> future)	Returns a successful append response.

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

onConfigure, onTransfer

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

forward, isRunning, logRequest, logResponse, shouldAcceptRequest, toString, updateTermAndLeader

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.atomix.utils.Managed

close

Constructor Details

PassiveRole

public PassiveRole(RaftContext context)

Method Details

start

public CompletableFuture<RaftRole> start()

Specified by:

start in interface Managed<RaftRole>

Overrides:

start in class AbstractRole

stop

public CompletableFuture<Void> stop()

Specified by:

stop in interface Managed<RaftRole>

Overrides:

stop in class AbstractRole

role

public RaftServer.Role role()

Description copied from interface: RaftRole

Returns the server state type.

Specified by:

role in interface RaftRole

Overrides:

role in class InactiveRole

Returns:

The server state type.

onInstall

public CompletableFuture<InstallResponse> onInstall(InstallRequest request)

Description copied from interface: RaftRole

Handles an install request.

Specified by:

onInstall in interface RaftRole

Overrides:

onInstall in class InactiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onReconfigure

public CompletableFuture<ReconfigureResponse> onReconfigure(ReconfigureRequest request)

Description copied from interface: RaftRole

Handles a configure request.

Specified by:

onReconfigure in interface RaftRole

Overrides:

onReconfigure in class InactiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onForceConfigure

public CompletableFuture<ForceConfigureResponse> onForceConfigure(ForceConfigureRequest request)

Description copied from interface: RaftRole

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.

Specified by:

onForceConfigure in interface RaftRole

Overrides:

onForceConfigure in class InactiveRole

onJoin

public CompletableFuture<JoinResponse> onJoin(JoinRequest request)

Description copied from interface: RaftRole

Handles a request to join the cluster.

Specified by:

onJoin in interface RaftRole

Overrides:

onJoin in class InactiveRole

onLeave

public CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)

Description copied from interface: RaftRole

Handles a request to leave the cluster.

Specified by:

onLeave in interface RaftRole

Overrides:

onLeave in class InactiveRole

onAppend

public CompletableFuture<AppendResponse> onAppend(InternalAppendRequest request)

Description copied from interface: RaftRole

Handles an append request.

Specified by:

onAppend in interface RaftRole

Overrides:

onAppend in class InactiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onPoll

public CompletableFuture<PollResponse> onPoll(PollRequest request)

Description copied from interface: RaftRole

Handles a poll request.

Specified by:

onPoll in interface RaftRole

Overrides:

onPoll in class InactiveRole

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 InactiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

handleAppend

protected CompletableFuture<AppendResponse> handleAppend(InternalAppendRequest request)

Handles an AppendRequest.

checkTerm

protected boolean checkTerm(InternalAppendRequest request,
 CompletableFuture<AppendResponse> future)

Checks the leader's term of the given AppendRequest, returning a boolean indicating whether to continue handling the request.

checkPreviousEntry

protected boolean checkPreviousEntry(InternalAppendRequest request,
 CompletableFuture<AppendResponse> future)

Checks the previous index of the given AppendRequest, returning a boolean indicating whether to continue handling the request.

appendEntries

protected void appendEntries(InternalAppendRequest request,
 CompletableFuture<AppendResponse> future)

Appends entries from the given AppendRequest.

failAppend

protected boolean failAppend(long lastLogIndex,
 CompletableFuture<AppendResponse> future)

Returns a failed append response.

Parameters:

lastLogIndex - the last log index

future - the append response future

Returns:

the append response status

succeedAppend

protected boolean succeedAppend(long lastLogIndex,
 CompletableFuture<AppendResponse> future)

Returns a successful append response.

Parameters:

lastLogIndex - the last log index

future - the append response future

Returns:

the append response status

completeAppend

protected boolean completeAppend(boolean succeeded,
 long lastLogIndex,
 CompletableFuture<AppendResponse> future)

Returns a successful append response.

Parameters:

succeeded - whether the append succeeded

lastLogIndex - the last log index

future - the append response future

Returns:

the append response status