Package io.atomix.raft.roles

Class LeaderRole

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

All Implemented Interfaces:

RaftRole, ZeebeLogAppender, Managed<RaftRole>, AutoCloseable

public final class LeaderRole
extends ActiveRole
implements ZeebeLogAppender

Leader state.

Nested Class Summary

Nested classes/interfaces inherited from interface io.atomix.raft.zeebe.ZeebeLogAppender

ZeebeLogAppender.AppendListener

Field Summary

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

log, raft

Constructor Summary

Constructors

Constructor	Description
LeaderRole(RaftContext context)

Method Summary

Modifier and Type	Method	Description
void	appendEntry(long lowestPosition, long highestPosition, BufferWriter data, ZeebeLogAppender.AppendListener appendListener)	Appends an entry to the local Raft log and schedules replication to each follower.
void	appendEntry(long lowestPosition, long highestPosition, ByteBuffer data, ZeebeLogAppender.AppendListener appendListener)	Appends an entry to the local Raft log and schedules replication to each follower.
void	appendEntry(ApplicationEntry entry, ZeebeLogAppender.AppendListener appendListener)	Appends an entry to the local Raft log and schedules replication to each follower.
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.
void	onInitialEntriesCommitted(Runnable runnable)
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.
CompletableFuture<RaftRole>	start()
CompletableFuture<Void>	stop()

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

handlePoll, handleVote

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

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

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

LeaderRole

public LeaderRole(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 interface: RaftRole

Returns the server state type.

Specified by:

role in interface RaftRole

Overrides:

role in class PassiveRole

Returns:

The server state type.

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.

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 PassiveRole

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 PassiveRole

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 PassiveRole

onConfigure

public CompletableFuture<ConfigureResponse> onConfigure(ConfigureRequest request)

Description copied from interface: RaftRole

Handles a configure request.

Specified by:

onConfigure in interface RaftRole

Overrides:

onConfigure in class InactiveRole

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.

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 ActiveRole

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.

appendEntry

public void appendEntry(ApplicationEntry entry,
 ZeebeLogAppender.AppendListener appendListener)

Description copied from interface: ZeebeLogAppender

Appends an entry to the local Raft log and schedules replication to each follower.

Specified by:

appendEntry in interface ZeebeLogAppender

appendEntry

public void appendEntry(long lowestPosition,
 long highestPosition,
 ByteBuffer data,
 ZeebeLogAppender.AppendListener appendListener)

Description copied from interface: ZeebeLogAppender

Appends an entry to the local Raft log and schedules replication to each follower.

Specified by:

appendEntry in interface ZeebeLogAppender

Parameters:

lowestPosition - lowest record position in the data buffer

highestPosition - highest record position in the data buffer

data - data to store in the entry

appendEntry

public void appendEntry(long lowestPosition,
 long highestPosition,
 BufferWriter data,
 ZeebeLogAppender.AppendListener appendListener)

Description copied from interface: ZeebeLogAppender

Appends an entry to the local Raft log and schedules replication to each follower.

Specified by:

appendEntry in interface ZeebeLogAppender

Parameters:

lowestPosition - lowest record position in the data buffer

highestPosition - highest record position in the data buffer

data - data to store in the entry

onInitialEntriesCommitted

public void onInitialEntriesCommitted(Runnable runnable)