io.atomix.protocols.raft.service

Class RaftServiceContext

java.lang.Object

io.atomix.protocols.raft.service.RaftServiceContext

All Implemented Interfaces:

ServiceContext

public class RaftServiceContext
extends java.lang.Object
implements ServiceContext

Raft server state machine executor.

Constructor Summary

Constructors

Constructor and Description
RaftServiceContext(PrimitiveId primitiveId, java.lang.String serviceName, PrimitiveType primitiveType, ServiceConfig config, PrimitiveService service, io.atomix.protocols.raft.impl.RaftContext raft, io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the service context.
void	closeSession(long index, long timestamp, RaftSession session, boolean expired) Unregister the given session.
void	completeKeepAlive(long index, long timestamp) Completes a keep-alive.
long	currentIndex()
OperationType	currentOperation()
Session	currentSession()
boolean	deleted() Returns a boolean indicating whether the service has been deleted.
io.atomix.protocols.raft.impl.OperationResult	executeCommand(long index, long sequence, long timestamp, RaftSession session, PrimitiveOperation operation) Executes the given command on the state machine.
java.util.concurrent.CompletableFuture<io.atomix.protocols.raft.impl.OperationResult>	executeQuery(long index, long sequence, long timestamp, RaftSession session, PrimitiveOperation operation) Executes the given query on the state machine.
void	installSnapshot(io.atomix.protocols.raft.storage.snapshot.SnapshotReader reader) Installs a snapshot.
boolean	keepAlive(long index, long timestamp, RaftSession session, long commandSequence, long eventIndex) Keeps the given session alive.
void	keepAliveSessions(long index, long timestamp) Keeps all sessions alive using the given timestamp.
MemberId	localMemberId()
LogicalClock	logicalClock()
long	openSession(long index, long timestamp, RaftSession session) Registers the given session.
Serializer	serializer()
<C extends ServiceConfig> C	serviceConfig()
PrimitiveId	serviceId()
java.lang.String	serviceName()
PrimitiveType	serviceType()
void	takeSnapshot(io.atomix.protocols.raft.storage.snapshot.SnapshotWriter writer) Takes a snapshot of the service state.
java.lang.String	toString()
WallClock	wallClock()

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftServiceContext

public RaftServiceContext(PrimitiveId primitiveId,
                          java.lang.String serviceName,
                          PrimitiveType primitiveType,
                          ServiceConfig config,
                          PrimitiveService service,
                          io.atomix.protocols.raft.impl.RaftContext raft,
                          io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory)

Method Detail

deleted

public boolean deleted()

Returns a boolean indicating whether the service has been deleted.

Returns:

indicates whether the service has been deleted

localMemberId

public MemberId localMemberId()

Specified by:

localMemberId in interface ServiceContext

serviceId

public PrimitiveId serviceId()

Specified by:

serviceId in interface ServiceContext

serviceName

public java.lang.String serviceName()

Specified by:

serviceName in interface ServiceContext

serviceType

public PrimitiveType serviceType()

Specified by:

serviceType in interface ServiceContext

serviceConfig

public <C extends ServiceConfig> C serviceConfig()

Specified by:

serviceConfig in interface ServiceContext

serializer

public Serializer serializer()

currentIndex

public long currentIndex()

Specified by:

currentIndex in interface ServiceContext

currentSession

public Session currentSession()

Specified by:

currentSession in interface ServiceContext

currentOperation

public OperationType currentOperation()

Specified by:

currentOperation in interface ServiceContext

logicalClock

public LogicalClock logicalClock()

Specified by:

logicalClock in interface ServiceContext

wallClock

public WallClock wallClock()

Specified by:

wallClock in interface ServiceContext

installSnapshot

public void installSnapshot(io.atomix.protocols.raft.storage.snapshot.SnapshotReader reader)

Installs a snapshot.

takeSnapshot

public void takeSnapshot(io.atomix.protocols.raft.storage.snapshot.SnapshotWriter writer)

Takes a snapshot of the service state.

openSession

public long openSession(long index,
                        long timestamp,
                        RaftSession session)

Registers the given session.

Parameters:

index - The index of the registration.

timestamp - The timestamp of the registration.

session - The session to register.

keepAlive

public boolean keepAlive(long index,
                         long timestamp,
                         RaftSession session,
                         long commandSequence,
                         long eventIndex)

Keeps the given session alive.

Parameters:

index - The index of the keep-alive.

timestamp - The timestamp of the keep-alive.

session - The session to keep-alive.

commandSequence - The session command sequence number.

eventIndex - The session event index.

completeKeepAlive

public void completeKeepAlive(long index,
                              long timestamp)

Completes a keep-alive.

Parameters:

index - the keep-alive index

timestamp - the keep-alive timestamp

keepAliveSessions

public void keepAliveSessions(long index,
                              long timestamp)

Keeps all sessions alive using the given timestamp.

Parameters:

index - the index of the timestamp

timestamp - the timestamp with which to reset session timeouts

closeSession

public void closeSession(long index,
                         long timestamp,
                         RaftSession session,
                         boolean expired)

Unregister the given session.

Parameters:

index - The index of the unregister.

timestamp - The timestamp of the unregister.

session - The session to unregister.

expired - Whether the session was expired by the leader.

executeCommand

public io.atomix.protocols.raft.impl.OperationResult executeCommand(long index,
                                                                    long sequence,
                                                                    long timestamp,
                                                                    RaftSession session,
                                                                    PrimitiveOperation operation)

Executes the given command on the state machine.

Parameters:

index - The index of the command.

timestamp - The timestamp of the command.

sequence - The command sequence number.

session - The session that submitted the command.

operation - The command to execute.

Returns:

A future to be completed with the command result.

executeQuery

public java.util.concurrent.CompletableFuture<io.atomix.protocols.raft.impl.OperationResult> executeQuery(long index,
                                                                                                          long sequence,
                                                                                                          long timestamp,
                                                                                                          RaftSession session,
                                                                                                          PrimitiveOperation operation)

Executes the given query on the state machine.

Parameters:

index - The index of the query.

sequence - The query sequence number.

timestamp - The timestamp of the query.

session - The session that submitted the query.

operation - The query to execute.

Returns:

A future to be completed with the query result.

close

public void close()

Closes the service context.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object