org.snf4j.websocket

Interface IWebSocketSession

All Superinterfaces:

ISession, IStreamSession

All Known Implementing Classes:

SSLWebSocketSession, WebSocketSession

public interface IWebSocketSession
extends IStreamSession

Extends the IStreamSession interface to cover the Web Socket functionalities.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
void	close(int status) Writes the Web Socket close frame with given status code and then gently closes this session.
void	close(int status, String reason) Writes the Web Socket close frame with given status code and reason and then gently closes this session.
IHandshaker	getHandshaker() Returns the Web Socket handshaker associated with this session.
IWebSocketHandler	getWebSocketHandler() Returns the Web Socket handler associated with this session

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

getHandler, getParent, getPipeline, write, write, write, write, write, write, writenf, writenf, writenf, writenf, writenf, writenf

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

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

Method Detail

getWebSocketHandler

IWebSocketHandler getWebSocketHandler()

Returns the Web Socket handler associated with this session

Returns:

the Web Socket handler

getHandshaker

IHandshaker getHandshaker()

Returns the Web Socket handshaker associated with this session.

Returns:

the Web Socket handshaker

close

void close(int status)

Writes the Web Socket close frame with given status code and then gently closes this session.

Parameters:

status - the status code of the close frame, or -1 if the close frame should not contain the application body.

close

void close(int status,
           String reason)

Writes the Web Socket close frame with given status code and reason and then gently closes this session.

Parameters:

status - the status code of the close frame, or -1 if the close frame should not contain the application body.

reason - the reason of the close frame. If the status argument equals -1 this argument is ignored.