io.atomix.protocols.raft.service

Class RaftServiceContext

java.lang.Object

io.atomix.protocols.raft.service.RaftServiceContext

All Implemented Interfaces:

io.atomix.primitive.service.ServiceContext

public class RaftServiceContext
extends Object
implements io.atomix.primitive.service.ServiceContext

Raft server state machine executor.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	closeSession(long index, long timestamp, RaftSession session, boolean expired) Unregister the given session.
CompletableFuture<Void>	completeKeepAlive(long index, long timestamp) Completes a keep-alive.
CompletableFuture<Void>	completeSnapshot(long index) Completes a snapshot of the service state.
long	currentIndex()
io.atomix.primitive.operation.OperationType	currentOperation()
io.atomix.primitive.session.Session	currentSession()
CompletableFuture<io.atomix.protocols.raft.impl.OperationResult>	executeCommand(long index, long sequence, long timestamp, RaftSession session, io.atomix.primitive.operation.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, io.atomix.primitive.operation.PrimitiveOperation operation) Executes the given query on the state machine.
io.atomix.utils.concurrent.ThreadContext	executor() Returns the state machine executor.
boolean	isUnderHighLoad() Returns a boolean indicating whether the service is under high load.
CompletableFuture<Boolean>	keepAlive(long index, long timestamp, RaftSession session, long commandSequence, long eventIndex) Keeps the given session alive.
CompletableFuture<Void>	keepAliveSessions(long index, long timestamp) Keeps all sessions alive using the given timestamp.
io.atomix.utils.time.LogicalClock	logicalClock()
CompletableFuture<Long>	openSession(long index, long timestamp, RaftSession session) Registers the given session.
io.atomix.primitive.PrimitiveId	serviceId()
String	serviceName()
io.atomix.primitive.PrimitiveType	serviceType()
io.atomix.primitive.session.Sessions	sessions()
CompletableFuture<Long>	takeSnapshot(long index) Takes a snapshot of the service state.
String	toString()
io.atomix.utils.time.WallClock	wallClock()

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftServiceContext

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

Method Detail

serviceId

public io.atomix.primitive.PrimitiveId serviceId()

Specified by:

serviceId in interface io.atomix.primitive.service.ServiceContext

serviceName

public String serviceName()

Specified by:

serviceName in interface io.atomix.primitive.service.ServiceContext

serviceType

public io.atomix.primitive.PrimitiveType serviceType()

Specified by:

serviceType in interface io.atomix.primitive.service.ServiceContext

currentIndex

public long currentIndex()

Specified by:

currentIndex in interface io.atomix.primitive.service.ServiceContext

currentSession

public io.atomix.primitive.session.Session currentSession()

Specified by:

currentSession in interface io.atomix.primitive.service.ServiceContext

currentOperation

public io.atomix.primitive.operation.OperationType currentOperation()

Specified by:

currentOperation in interface io.atomix.primitive.service.ServiceContext

logicalClock

public io.atomix.utils.time.LogicalClock logicalClock()

Specified by:

logicalClock in interface io.atomix.primitive.service.ServiceContext

wallClock

public io.atomix.utils.time.WallClock wallClock()

Specified by:

wallClock in interface io.atomix.primitive.service.ServiceContext

sessions

public io.atomix.primitive.session.Sessions sessions()

Specified by:

sessions in interface io.atomix.primitive.service.ServiceContext

isUnderHighLoad

public boolean isUnderHighLoad()

Returns a boolean indicating whether the service is under high load.

Returns:

indicates whether the service is under high load

executor

public io.atomix.utils.concurrent.ThreadContext executor()

Returns the state machine executor.

Returns:

The state machine executor.

takeSnapshot

public CompletableFuture<Long> takeSnapshot(long index)

Takes a snapshot of the service state.

Parameters:

index - takes a snapshot at the given index

Returns:

a future to be completed once the snapshot has been taken

completeSnapshot

public CompletableFuture<Void> completeSnapshot(long index)

Completes a snapshot of the service state.

Parameters:

index - the index of the snapshot to complete

Returns:

a future to be completed once the snapshot has been completed

openSession

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<Void> completeKeepAlive(long index,
                                                 long timestamp)

Completes a keep-alive.

Parameters:

index - the keep-alive index

timestamp - the keep-alive timestamp

Returns:

future to be completed once the keep alive is completed

keepAliveSessions

public CompletableFuture<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

Returns:

future to be completed once all sessions have been preserved

closeSession

public CompletableFuture<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 CompletableFuture<io.atomix.protocols.raft.impl.OperationResult> executeCommand(long index,
                                                                                       long sequence,
                                                                                       long timestamp,
                                                                                       RaftSession session,
                                                                                       io.atomix.primitive.operation.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,
                                                                                     io.atomix.primitive.operation.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