io.atomix.protocols.raft.roles

Class LeaderRole

java.lang.Object

io.atomix.protocols.raft.roles.AbstractRole

io.atomix.protocols.raft.roles.InactiveRole

io.atomix.protocols.raft.roles.PassiveRole

io.atomix.protocols.raft.roles.ActiveRole

io.atomix.protocols.raft.roles.LeaderRole

All Implemented Interfaces:

RaftRole, io.atomix.utils.Managed<RaftRole>

public final class LeaderRole
extends ActiveRole

Leader state.

Constructor Summary

Constructors

Constructor and Description
LeaderRole(io.atomix.protocols.raft.impl.RaftContext context)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close()
CompletableFuture<AppendResponse>	onAppend(AppendRequest request) Handles an append request.
CompletableFuture<CloseSessionResponse>	onCloseSession(CloseSessionRequest request) Handles a close session request.
CompletableFuture<CommandResponse>	onCommand(CommandRequest request) Handles a command request.
CompletableFuture<JoinResponse>	onJoin(JoinRequest request) Handles a join request.
CompletableFuture<KeepAliveResponse>	onKeepAlive(KeepAliveRequest request) Handles a keep alive request.
CompletableFuture<LeaveResponse>	onLeave(LeaveRequest request) Handles a leave request.
CompletableFuture<MetadataResponse>	onMetadata(MetadataRequest request) Handles a metadata request.
CompletableFuture<OpenSessionResponse>	onOpenSession(OpenSessionRequest request) Handles an open session request.
CompletableFuture<PollResponse>	onPoll(PollRequest request) Handles a poll request.
CompletableFuture<QueryResponse>	onQuery(QueryRequest request) Handles a query 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.
CompletableFuture<RaftRole>	open()
RaftServer.Role	role() Returns the Raft state represented by this state.

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

onInstall

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

onConfigure

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

isClosed, isOpen, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LeaderRole

public LeaderRole(io.atomix.protocols.raft.impl.RaftContext context)

Method Detail

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.

open

public CompletableFuture<RaftRole> open()

Specified by:

open in interface io.atomix.utils.Managed<RaftRole>

Overrides:

open in class PassiveRole

onJoin

public CompletableFuture<JoinResponse> onJoin(JoinRequest request)

Description copied from interface: RaftRole

Handles a join request.

Specified by:

onJoin in interface RaftRole

Overrides:

onJoin in class PassiveRole

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 PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onLeave

public CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)

Description copied from interface: RaftRole

Handles a leave request.

Specified by:

onLeave in interface RaftRole

Overrides:

onLeave in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onTransfer

public CompletableFuture<TransferResponse> onTransfer(TransferRequest request)

Description copied from interface: RaftRole

Handles a transfer request.

Specified by:

onTransfer in interface RaftRole

Overrides:

onTransfer 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 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.

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.

onMetadata

public CompletableFuture<MetadataResponse> onMetadata(MetadataRequest request)

Description copied from interface: RaftRole

Handles a metadata request.

Specified by:

onMetadata in interface RaftRole

Overrides:

onMetadata in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onCommand

public CompletableFuture<CommandResponse> onCommand(CommandRequest request)

Description copied from interface: RaftRole

Handles a command request.

Specified by:

onCommand in interface RaftRole

Overrides:

onCommand in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onQuery

public CompletableFuture<QueryResponse> onQuery(QueryRequest request)

Description copied from interface: RaftRole

Handles a query request.

Specified by:

onQuery in interface RaftRole

Overrides:

onQuery in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onOpenSession

public CompletableFuture<OpenSessionResponse> onOpenSession(OpenSessionRequest request)

Description copied from interface: RaftRole

Handles an open session request.

Specified by:

onOpenSession in interface RaftRole

Overrides:

onOpenSession in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onKeepAlive

public CompletableFuture<KeepAliveResponse> onKeepAlive(KeepAliveRequest request)

Description copied from interface: RaftRole

Handles a keep alive request.

Specified by:

onKeepAlive in interface RaftRole

Overrides:

onKeepAlive in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

onCloseSession

public CompletableFuture<CloseSessionResponse> onCloseSession(CloseSessionRequest request)

Description copied from interface: RaftRole

Handles a close session request.

Specified by:

onCloseSession in interface RaftRole

Overrides:

onCloseSession in class PassiveRole

Parameters:

request - The request to handle.

Returns:

A completable future to be completed with the request response.

close

public CompletableFuture<Void> close()

Specified by:

close in interface io.atomix.utils.Managed<RaftRole>

Overrides:

close in class PassiveRole