com.hazelcast.cp.internal

Class RaftOp

java.lang.Object

com.hazelcast.cp.internal.RaftOp

All Implemented Interfaces:

DataSerializable

Direct Known Subclasses:

AbstractAtomicLongOp, AbstractAtomicRefOp, AbstractCountDownLatchOp, AcquirePermitsOp, AvailablePermitsOp, ChangePermitsOp, CloseInactiveSessionsOp, CloseSessionOp, CreateSessionOp, DestroyRaftObjectOp, DrainPermitsOp, ExpireSessionsOp, ExpireWaitKeysOp, GenerateThreadIdOp, GetInitialRaftGroupMembersIfCurrentGroupMemberOp, GetLockOwnershipStateOp, GetSessionsOp, HeartbeatSessionOp, InitSemaphoreOp, LockOp, MetadataRaftGroupOp, NotifyTermChangeOp, ReleasePermitsOp, RestoreSnapshotOp, TryLockOp, UnlockOp

public abstract class RaftOp
extends Object
implements DataSerializable

Base operation class for operations to be replicated to and executed on Raft group members.

RaftOp is stored in Raft log by leader and replicated to followers. When at least majority of the members append it to their logs, the log entry which it belongs is committed and RaftOp is executed eventually on each member.

Note that, implementations of RaftOp must be deterministic. They should perform the same action and produce the same result always, independent of where and when they are executed.

run(CPGroupId, long) method must be implemented by subclasses.

Constructor Summary

Constructors

Constructor and Description
RaftOp()

Method Summary

Modifier and Type	Method and Description
protected ILogger	getLogger()
NodeEngine	getNodeEngine()
<T> T	getService()
protected abstract String	getServiceName()
void	logFailure(Throwable e)
abstract Object	run(CPGroupId groupId, long commitIndex) Contains actual Raft operation logic.
RaftOp	setNodeEngine(NodeEngine nodeEngine)
String	toString()
protected void	toString(StringBuilder sb)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Constructor Detail

RaftOp

public RaftOp()

Method Detail

run

public abstract Object run(CPGroupId groupId,
                           long commitIndex)
                    throws Exception

Contains actual Raft operation logic. State change represented by this operation should be applied and execution result should be returned to the caller.

Parameters:

groupId - groupId of the specific Raft group

commitIndex - commitIndex of the log entry keeping this operation

Returns:

result of the operation execution

Throws:

Exception

getNodeEngine

public NodeEngine getNodeEngine()

setNodeEngine

public RaftOp setNodeEngine(NodeEngine nodeEngine)

getService

public <T> T getService()

getLogger

protected ILogger getLogger()

getServiceName

protected abstract String getServiceName()

logFailure

public void logFailure(Throwable e)

toString

protected void toString(StringBuilder sb)

toString

public final String toString()

Overrides:

toString in class Object