io.atomix.protocols.raft.session

Interface RaftSessions

All Superinterfaces:

Iterable<RaftSession>

public interface RaftSessions
extends Iterable<RaftSession>

Provides a set of active server sessions.

Server state machines can use the Sessions object to access the list of sessions currently open to the state machine. Session sets are guaranteed to be deterministic. All state machines will see the same set of open sessions at the same point in the log except in cases where a session has already been closed and removed. If a session has already been closed on another server, the session is guaranteed to have been expired on all servers and thus operations like RaftSession.publish(io.atomix.protocols.raft.event.RaftEvent) are effectively no-ops.

Method Summary

Modifier and Type	Method and Description
RaftSessions	addListener(RaftSessionListener listener) Adds a listener to the sessions.
RaftSession	getSession(long sessionId) Returns a session by session ID.
RaftSessions	removeListener(RaftSessionListener listener) Removes a listener from the sessions.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getSession

RaftSession getSession(long sessionId)

Returns a session by session ID.

Parameters:

sessionId - The session ID.

Returns:

The session or null if no session with the given sessionId exists.

addListener

RaftSessions addListener(RaftSessionListener listener)

Adds a listener to the sessions.

Parameters:

listener - The listener to add.

Returns:

The sessions.

Throws:

NullPointerException - if the session listener is null

removeListener

RaftSessions removeListener(RaftSessionListener listener)

Removes a listener from the sessions.

Parameters:

listener - The listener to remove.

Returns:

The sessions.