org.snf4j.core.session

Interface IEngineSession

All Superinterfaces:

ISession

All Known Subinterfaces:

IEngineDatagramSession, IEngineStreamSession

All Known Implementing Classes:

DTLSSession, EngineDatagramSession, EngineSession, EngineStreamSession, SSLSession, SSLWebSocketSession

public interface IEngineSession
extends ISession

A engine-driven session which represents connection between end-points regardless of transport type. Sessions implementing this interface handle protocols driven by customized protocol engines implementing the IEngine interface.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
void	beginHandshake() Initiates handshaking (initial or renegotiation) on the protocol engine driving this session.
void	beginLazyHandshake() Initiates lazy handshaking (initial or renegotiation) on the protocol engine driving this session.
Object	getEngineSession() Returns an object representing a session in the protocol engine driving this session.
Executor	getExecutor() Returns the executor that is used to execute delegated tasks required by this session to complete operations that block, or may take an extended period of time to complete.
void	setExecutor(Executor executor) Sets the executor that will be used to execute delegated tasks required by this session to complete operations that block, or may take an extended period of time to complete.

Methods inherited from interface org.snf4j.core.session.ISession

allocate, close, dirtyClose, execute, executenf, getAttributes, getCloseFuture, getCodecPipeline, getConfig, getCreateFuture, getCreationTime, getEndFuture, getHandler, getId, getLastIoTime, getLastReadTime, getLastWriteTime, getLocalAddress, getName, getOpenFuture, getParent, getReadBytes, getReadBytesThroughput, getReadyFuture, getRemoteAddress, getState, getTimer, getWrittenBytes, getWrittenBytesThroughput, isDataCopyingOptimized, isOpen, isReadSuspended, isWriteSuspended, quickClose, release, resumeRead, resumeWrite, suspendRead, suspendWrite

Method Detail

setExecutor

void setExecutor(Executor executor)

Sets the executor that will be used to execute delegated tasks required by this session to complete operations that block, or may take an extended period of time to complete.

Parameters:

executor - the new executor, or null to use the executor configured in the selector loop that handles this session.

getExecutor

Executor getExecutor()

Returns the executor that is used to execute delegated tasks required by this session to complete operations that block, or may take an extended period of time to complete.

By default, this method returns the executor configured in the selector loop that handles this session, or null.

Returns:

the current executor, or null if the executor is undefined (i.e. the session is not associated with the selector loop and the executor is not set)

beginHandshake

void beginHandshake()

Initiates handshaking (initial or renegotiation) on the protocol engine driving this session. After calling this method the handshake will start immediately.

This method is not needed for the initial handshake, as the wrap and unwrap methods of the protocol engine should initiate it if the handshaking has not already begun.

The operation is asynchronous.

beginLazyHandshake

void beginLazyHandshake()

Initiates lazy handshaking (initial or renegotiation) on the protocol engine driving this session. After calling this method the handshake will not start immediately. It will start when new data is received from a remote peer or following methods are called: write, writenf, beginHandshake.

This method is not needed for the initial handshake, as the wrap and unwrap methods of the protocol engine should initiate it if the handshaking has not already begun.

The operation is asynchronous.

getEngineSession

Object getEngineSession()

Returns an object representing a session in the protocol engine driving this session.

Returns:

an object representing a session.

Throws:

UnsupportedOperationException - if the protocol engine driving this session does not support a session.