Package io.atomix.raft.roles

Class AbstractRole

java.lang.Object

io.atomix.raft.roles.AbstractRole

All Implemented Interfaces:

RaftRole, Managed<RaftRole>

Direct Known Subclasses:

InactiveRole

public abstract class AbstractRole
extends Object
implements RaftRole

Abstract state.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	log
protected final RaftContext	raft

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRole(RaftContext raft)

Method Summary

Modifier and Type	Method	Description
protected <T extends RaftRequest, U extends RaftResponse> CompletableFuture<U>	forward(T request, BiFunction<MemberId,T,CompletableFuture<U>> function)	Forwards the given request to the leader if possible.
boolean	isRunning()
protected final <R extends RaftRequest> R	logRequest(R request)	Logs a request.
protected final <R extends RaftResponse> R	logResponse(R response)	Logs a response.
abstract RaftServer.Role	role()	Returns the Raft state represented by this state.
CompletableFuture<RaftRole>	start()
CompletableFuture<Void>	stop()
String	toString()
protected boolean	updateTermAndLeader(long term, MemberId leader)	Updates the term and leader.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.atomix.raft.roles.RaftRole

onAppend, onConfigure, onInstall, onPoll, onReconfigure, onTransfer, onVote

Field Details

log

protected final org.slf4j.Logger log

raft

protected final RaftContext raft

Constructor Details

AbstractRole

protected AbstractRole(RaftContext raft)

Method Details

role

public abstract RaftServer.Role role()

Returns the Raft state represented by this state.

Specified by:

role in interface RaftRole

Returns:

The Raft state represented by this state.

logRequest

protected final <R extends RaftRequest> R logRequest(R request)

Logs a request.

logResponse

protected final <R extends RaftResponse> R logResponse(R response)

Logs a response.

start

public CompletableFuture<RaftRole> start()

Specified by:

start in interface Managed<RaftRole>

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Managed<RaftRole>

stop

public CompletableFuture<Void> stop()

Specified by:

stop in interface Managed<RaftRole>

forward

protected <T extends RaftRequest,
U extends RaftResponse>
CompletableFuture<U> forward(T request,
 BiFunction<MemberId,T,CompletableFuture<U>> function)

Forwards the given request to the leader if possible.

updateTermAndLeader

protected boolean updateTermAndLeader(long term,
 MemberId leader)

Updates the term and leader.

toString

public String toString()

Overrides:

toString in class Object