io.atomix.protocols.raft.service

Class RaftServiceContext

java.lang.Object

io.atomix.protocols.raft.service.RaftServiceContext

All Implemented Interfaces:

ServiceContext

public class RaftServiceContext
extends Object
implements ServiceContext

Raft server state machine executor.

Constructor Summary

Constructors

Constructor and Description
RaftServiceContext(PrimitiveId primitiveId, 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	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() Returns the current state machine index.
OperationType	currentOperation() Returns the current operation type.
Session	currentSession() Returns the current session.
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.
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.
LogicalClock	logicalClock() Returns the state machine's logical clock.
long	openSession(long index, long timestamp, RaftSession session) Registers the given session.
Serializer	serializer()
<C extends ServiceConfig> C	serviceConfig() Returns the service configuration.
PrimitiveId	serviceId() Returns the state machine identifier.
String	serviceName() Returns the state machine name.
PrimitiveType	serviceType() Returns the state machine type.
void	takeSnapshot(io.atomix.protocols.raft.storage.snapshot.SnapshotWriter writer) Takes a snapshot of the service state.
String	toString()
WallClock	wallClock() Returns the state machine's wall clock.

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftServiceContext

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

Method Detail

serviceId

public PrimitiveId serviceId()

Description copied from interface: ServiceContext

Returns the state machine identifier.

Specified by:

serviceId in interface ServiceContext

Returns:

The unique state machine identifier.

serviceName

public String serviceName()

Description copied from interface: ServiceContext

Returns the state machine name.

Specified by:

serviceName in interface ServiceContext

Returns:

The state machine name.

serviceType

public PrimitiveType serviceType()

Description copied from interface: ServiceContext

Returns the state machine type.

Specified by:

serviceType in interface ServiceContext

Returns:

The state machine type.

serviceConfig

public <C extends ServiceConfig> C serviceConfig()

Description copied from interface: ServiceContext

Returns the service configuration.

Specified by:

serviceConfig in interface ServiceContext

Type Parameters:

C - the configuration type

Returns:

the service configuration

serializer

public Serializer serializer()

currentIndex

public long currentIndex()

Description copied from interface: ServiceContext

Returns the current state machine index.

The state index is indicative of the index of the current operation being applied to the server state machine. If a query is being applied, the index of the last command applied will be used.

Specified by:

currentIndex in interface ServiceContext

Returns:

The current state machine index.

currentSession

public Session currentSession()

Description copied from interface: ServiceContext

Returns the current session.

Specified by:

currentSession in interface ServiceContext

Returns:

the current session

currentOperation

public OperationType currentOperation()

Description copied from interface: ServiceContext

Returns the current operation type.

Specified by:

currentOperation in interface ServiceContext

Returns:

the current operation type

logicalClock

public LogicalClock logicalClock()

Description copied from interface: ServiceContext

Returns the state machine's logical clock.

Specified by:

logicalClock in interface ServiceContext

Returns:

The state machine's logical clock.

wallClock

public WallClock wallClock()

Description copied from interface: ServiceContext

Returns the state machine's wall clock.

Specified by:

wallClock in interface ServiceContext

Returns:

The state machine's wall clock.

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

toString

public String toString()

Overrides:

toString in class Object