RaftSession (Atomix API Reference (2.0.4))

```
public interface RaftSession
```
Provides an interface to communicating with a client via session events.
Sessions represent a connection between a single client and all servers in a Raft cluster. Session information is replicated via the Raft consensus algorithm, and clients can safely switch connections between servers without losing their session. All consistency guarantees are provided within the context of a session. Once a session is expired or closed, linearizability, sequential consistency, and other guarantees for events and operations are effectively lost. Session implementations guarantee linearizability for session messages by coordinating between the client and a single server at any given time. This means messages published via the RaftSession are guaranteed to arrive on the other side of the connection exactly once and in the order in which they are sent by replicated state machines. In the event of a server-to-client message being lost, the message will be resent so long as at least one Raft server is able to communicate with the client and the client's session does not expire while switching between servers.
Messages are sent to the other side of the session using the publish(RaftEvent) method:
```
   
     session.publish("myEvent", "Hello world!");
   
 
```
When the message is published, it will be queued to be sent to the other side of the connection. Raft guarantees that the message will eventually be received by the client unless the session itself times out or is closed.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class RaftSession.State
Session state enums.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RaftSession.State` Session state enums.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addListener(RaftSessionEventListener listener)` Adds a state change listener to the session.
`RaftSession.State`	`getState()` Returns the session state.
`long`	`maxTimeout()` Returns the maximum session timeout.
`MemberId`	`memberId()` Returns the member identifier to which the session belongs.
`long`	`minTimeout()` Returns the minimum session timeout.
`default void`	`publish(EventType eventType)` Publishes an empty event to the session.
`default void`	`publish(EventType eventType, byte[] event)` Publishes an event to the session.
`default <T> void`	`publish(EventType eventType, Function<T,byte[]> encoder, T event)` Publishes an event to the session.
`void`	`publish(RaftEvent event)` Publishes an event to the session.
`ReadConsistency`	`readConsistency()` Returns the session's read consistency.
`void`	`removeListener(RaftSessionEventListener listener)` Removes a state change listener from the session.
`String`	`serviceName()` Returns the session's service name.
`ServiceType`	`serviceType()` Returns the session's service type.
`SessionId`	`sessionId()` Returns the session identifier.
`default long`	`timeout()` Deprecated.

- Method Detail
  - sessionId
```
SessionId sessionId()
```
    Returns the session identifier.
    
    Returns:
    
    The session identifier.
  - serviceName
```
String serviceName()
```
    Returns the session's service name.
    
    Returns:
    
    The session's service name.
  - serviceType
```
ServiceType serviceType()
```
    Returns the session's service type.
    
    Returns:
    
    The session's service type.
  - memberId
```
MemberId memberId()
```
    Returns the member identifier to which the session belongs.
    
    Returns:
    
    The member to which the session belongs.
  - readConsistency
```
ReadConsistency readConsistency()
```
    Returns the session's read consistency.
    
    Returns:
    
    The session's read consistency.
  - timeout
```
@Deprecated
default long timeout()
```
    Deprecated.
    
    Returns the session timeout.
    
    Returns:
    
    The session timeout.
  - minTimeout
```
long minTimeout()
```
    Returns the minimum session timeout.
    
    Returns:
    
    The minimum session timeout.
  - maxTimeout
```
long maxTimeout()
```
    Returns the maximum session timeout.
    
    Returns:
    
    The maximum session timeout.
  - getState
```
RaftSession.State getState()
```
    Returns the session state.
    
    Returns:
    
    The session state.
  - addListener
```
void addListener(RaftSessionEventListener listener)
```
    Adds a state change listener to the session.
    
    Parameters:
    
    listener - the state change listener to add
  - removeListener
```
void removeListener(RaftSessionEventListener listener)
```
    Removes a state change listener from the session.
    
    Parameters:
    
    listener - the state change listener to remove
  - publish
```
default void publish(EventType eventType)
```
    Publishes an empty event to the session.
    
    Parameters:
    
    eventType - the event type
  - publish
```
default <T> void publish(EventType eventType,
                         Function<T,byte[]> encoder,
                         T event)
```
    Publishes an event to the session.
    
    Type Parameters:
    
    T - the event type
    
    Parameters:
    
    eventType - the event identifier
    
    encoder - the event value encoder
    
    event - the event value
  - publish
```
default void publish(EventType eventType,
                     byte[] event)
```
    Publishes an event to the session.
    
    Parameters:
    
    eventType - the event identifier
    
    event - the event to publish
    
    Throws:
    
    NullPointerException - if the event is null
  - publish
```
void publish(RaftEvent event)
```
    Publishes an event to the session.
    
    Parameters:
    
    event - the event to publish

Interface RaftSession

Nested Class Summary

Method Summary

Method Detail

sessionId

serviceName

serviceType

memberId

readConsistency

timeout

minTimeout

maxTimeout

getState

addListener

removeListener

publish

publish

publish

publish