io.atomix.protocols.raft.session

Class RaftSession

java.lang.Object

io.atomix.primitive.session.impl.AbstractSession

io.atomix.protocols.raft.session.RaftSession

All Implemented Interfaces:

Session

public class RaftSession
extends io.atomix.primitive.session.impl.AbstractSession

Raft session.

Nested Class Summary

Nested classes/interfaces inherited from interface io.atomix.primitive.session.Session

Session.State

Constructor Summary

Constructors

Constructor and Description
RaftSession(SessionId sessionId, MemberId member, java.lang.String name, PrimitiveType primitiveType, ReadConsistency readConsistency, long minTimeout, long maxTimeout, long lastUpdated, Serializer serializer, RaftServiceContext context, io.atomix.protocols.raft.impl.RaftContext server, io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<io.atomix.protocols.raft.impl.PendingCommand>	clearCommands() Clears and returns all pending commands.
void	clearResults(long sequence) Clears command results up to the given sequence number.
void	close() Closes the session.
void	commit(long index) Commits events for the given index.
boolean	equals(java.lang.Object object)
void	expire() Expires the session.
io.atomix.protocols.raft.impl.PendingCommand	getCommand(long sequence) Gets a pending command.
java.util.Collection<io.atomix.protocols.raft.impl.PendingCommand>	getCommands() Returns the collection of pending commands.
long	getCommandSequence() Returns the session operation sequence number.
long	getEventIndex() Returns the session event index.
long	getLastApplied() Returns the session index.
long	getLastCompleted() Returns the index of the highest event acked for the session.
long	getLastUpdated() Returns the session update timestamp.
long	getRequestSequence() Returns the session request number.
io.atomix.protocols.raft.impl.OperationResult	getResult(long sequence) Returns the session response for the given sequence number.
RaftServiceContext	getService() Returns the state machine context associated with the session.
Session.State	getState()
int	hashCode()
boolean	isTimedOut(long timestamp) Returns a boolean indicating whether the session is timed out.
long	maxTimeout() Returns the maximum session timeout.
long	minTimeout() Returns the minimum session timeout.
long	nextCommandSequence() Returns the next operation sequence number.
long	nextRequestSequence() Returns the next request sequence number.
void	open() Opens the session.
void	publish(PrimitiveEvent event)
ReadConsistency	readConsistency() Returns the session read consistency.
void	registerCommand(long sequence, io.atomix.protocols.raft.impl.PendingCommand pendingCommand) Registers a pending command.
void	registerIndexQuery(long index, java.lang.Runnable query) Registers a session index query.
void	registerResult(long sequence, io.atomix.protocols.raft.impl.OperationResult result) Registers a session result.
void	registerSequenceQuery(long sequence, java.lang.Runnable query) Registers a causal session query.
io.atomix.protocols.raft.impl.PendingCommand	removeCommand(long sequence) Removes and returns a pending command.
void	resendEvents(long index) Resends events from the given sequence.
void	resetRequestSequence(long requestSequence) Resets the current request sequence number.
void	setCommandSequence(long sequence) Sets the session operation sequence number.
void	setEventIndex(long eventIndex) Sets the session event index.
void	setLastApplied(long index) Sets the session index.
void	setLastCompleted(long lastCompleted) Sets the last completed event index for the session.
void	setLastUpdated(long lastUpdated) Updates the session timestamp.
void	setRequestSequence(long requestSequence) Sets the current request sequence number.
java.lang.String	toString()

Methods inherited from class io.atomix.primitive.session.impl.AbstractSession

accept, memberId, primitiveName, primitiveType, publish, sessionId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.atomix.primitive.session.Session

publish

Constructor Detail

RaftSession

public RaftSession(SessionId sessionId,
                   MemberId member,
                   java.lang.String name,
                   PrimitiveType primitiveType,
                   ReadConsistency readConsistency,
                   long minTimeout,
                   long maxTimeout,
                   long lastUpdated,
                   Serializer serializer,
                   RaftServiceContext context,
                   io.atomix.protocols.raft.impl.RaftContext server,
                   io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory)

Method Detail

readConsistency

public ReadConsistency readConsistency()

Returns the session read consistency.

Returns:

the session read consistency

minTimeout

public long minTimeout()

Returns the minimum session timeout.

Returns:

the minimum session timeout

maxTimeout

public long maxTimeout()

Returns the maximum session timeout.

Returns:

the maximum session timeout

getService

public RaftServiceContext getService()

Returns the state machine context associated with the session.

Returns:

The state machine context associated with the session.

getLastUpdated

public long getLastUpdated()

Returns the session update timestamp.

Returns:

The session update timestamp.

setLastUpdated

public void setLastUpdated(long lastUpdated)

Updates the session timestamp.

Parameters:

lastUpdated - The session timestamp.

isTimedOut

public boolean isTimedOut(long timestamp)

Returns a boolean indicating whether the session is timed out.

Parameters:

timestamp - the current timestamp

Returns:

indicates whether the session is timed out

getState

public Session.State getState()

getRequestSequence

public long getRequestSequence()

Returns the session request number.

Returns:

The session request number.

nextRequestSequence

public long nextRequestSequence()

Returns the next request sequence number.

Returns:

the next request sequence number

setRequestSequence

public void setRequestSequence(long requestSequence)

Sets the current request sequence number.

Parameters:

requestSequence - the current request sequence number

resetRequestSequence

public void resetRequestSequence(long requestSequence)

Resets the current request sequence number.

Parameters:

requestSequence - The request sequence number.

getCommandSequence

public long getCommandSequence()

Returns the session operation sequence number.

Returns:

The session operation sequence number.

nextCommandSequence

public long nextCommandSequence()

Returns the next operation sequence number.

Returns:

The next operation sequence number.

setCommandSequence

public void setCommandSequence(long sequence)

Sets the session operation sequence number.

Parameters:

sequence - The session operation sequence number.

getLastApplied

public long getLastApplied()

Returns the session index.

Returns:

The session index.

setLastApplied

public void setLastApplied(long index)

Sets the session index.

Parameters:

index - The session index.

registerSequenceQuery

public void registerSequenceQuery(long sequence,
                                  java.lang.Runnable query)

Registers a causal session query.

Parameters:

sequence - The session sequence number at which to execute the query.

query - The query to execute.

registerIndexQuery

public void registerIndexQuery(long index,
                               java.lang.Runnable query)

Registers a session index query.

Parameters:

index - The state machine index at which to execute the query.

query - The query to execute.

registerCommand

public void registerCommand(long sequence,
                            io.atomix.protocols.raft.impl.PendingCommand pendingCommand)

Registers a pending command.

Parameters:

sequence - the pending command sequence number

pendingCommand - the pending command to register

getCommand

public io.atomix.protocols.raft.impl.PendingCommand getCommand(long sequence)

Gets a pending command.

Parameters:

sequence - the pending command sequence number

Returns:

the pending command or null if no command is pending for this sequence number

getCommands

public java.util.Collection<io.atomix.protocols.raft.impl.PendingCommand> getCommands()

Returns the collection of pending commands.

Returns:

the collection of pending commands

removeCommand

public io.atomix.protocols.raft.impl.PendingCommand removeCommand(long sequence)

Removes and returns a pending command.

Parameters:

sequence - the pending command sequence number

Returns:

the pending command or null if no command is pending for this sequence number

clearCommands

public java.util.Collection<io.atomix.protocols.raft.impl.PendingCommand> clearCommands()

Clears and returns all pending commands.

Returns:

a collection of pending commands

registerResult

public void registerResult(long sequence,
                           io.atomix.protocols.raft.impl.OperationResult result)

Registers a session result.

Results are stored in memory on all servers in order to provide linearizable semantics. When a command is applied to the state machine, the command's return value is stored with the sequence number. Once the client acknowledges receipt of the command output the result will be cleared from memory.

Parameters:

sequence - The result sequence number.

result - The result.

clearResults

public void clearResults(long sequence)

Clears command results up to the given sequence number.

Command output is removed from memory up to the given sequence number. Additionally, since we know the client received a response for all commands up to the given sequence number, command futures are removed from memory as well.

Parameters:

sequence - The sequence to clear.

getResult

public io.atomix.protocols.raft.impl.OperationResult getResult(long sequence)

Returns the session response for the given sequence number.

Parameters:

sequence - The response sequence.

Returns:

The response.

getEventIndex

public long getEventIndex()

Returns the session event index.

Returns:

The session event index.

setEventIndex

public void setEventIndex(long eventIndex)

Sets the session event index.

Parameters:

eventIndex - the session event index

publish

public void publish(PrimitiveEvent event)

Specified by:

publish in interface Session

Specified by:

publish in class io.atomix.primitive.session.impl.AbstractSession

commit

public void commit(long index)

Commits events for the given index.

getLastCompleted

public long getLastCompleted()

Returns the index of the highest event acked for the session.

Returns:

The index of the highest event acked for the session.

setLastCompleted

public void setLastCompleted(long lastCompleted)

Sets the last completed event index for the session.

Parameters:

lastCompleted - the last completed index

resendEvents

public void resendEvents(long index)

Resends events from the given sequence.

Parameters:

index - The index from which to resend events.

open

public void open()

Opens the session.

expire

public void expire()

Expires the session.

close

public void close()

Closes the session.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object