Package io.atomix.raft.roles

Class InactiveRole

java.lang.Object

io.atomix.raft.roles.AbstractRole

io.atomix.raft.roles.InactiveRole

All Implemented Interfaces:

RaftRole, Managed<RaftRole>, AutoCloseable

Direct Known Subclasses:

PassiveRole

public class InactiveRole
extends AbstractRole

Inactive state.

Field Summary

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

log, raft

Constructor Summary

Constructors

Constructor	Description
InactiveRole(RaftContext context)

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.

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

forward, isRunning, logRequest, logResponse, shouldAcceptRequest, start, stop, 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

InactiveRole

public InactiveRole(RaftContext context)

Method Details

role

public RaftServer.Role role()

Description copied from interface: RaftRole

Returns the server state type.

Returns:

The server state type.

onConfigure

public CompletableFuture<ConfigureResponse> onConfigure(ConfigureRequest request)

Description copied from interface: RaftRole

Handles a configure request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onInstall

public CompletableFuture<InstallResponse> onInstall(InstallRequest request)

Description copied from interface: RaftRole

Handles an install request.

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.

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.

onJoin

public CompletableFuture<JoinResponse> onJoin(JoinRequest request)

Description copied from interface: RaftRole

Handles a request to join the cluster.

onLeave

public CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)

Description copied from interface: RaftRole

Handles a request to leave the cluster.

onTransfer

public CompletableFuture<TransferResponse> onTransfer(TransferRequest request)

Description copied from interface: RaftRole

Handles a transfer request.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onAppend

public CompletableFuture<AppendResponse> onAppend(InternalAppendRequest request)

Description copied from interface: RaftRole

Handles an append request.

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.

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.

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.