io.scalecube.socketio

Interface Session

All Known Subinterfaces:

ManagedSession

All Known Implementing Classes:

AbstractPollingSession, AbstractSession, AbstractSocketSession, FlashSocketSession, JsonpPollingSession, WebSocketSession, XHRPollingSession

public interface Session

When client handshake and connects to the socket.io server a session is created this session handles the communication with a specific client connection each client is represented with specific session id that is correlated in the communication protocol.

Author:

Ronen Hamias, Anton Kharenko

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Session.State

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnects this session
int	getLocalPort() Returns local port to which client connection is established.
String	getOrigin() Returns origin header of this session.
SocketAddress	getRemoteAddress() Returns remote address of the client.
String	getSessionId() Returns session identifier.
Session.State	getState() Returns session state (see Session.State).
TransportType	getTransportType() Returns transport type for this session (e.g.
TransportType	getUpgradedFromTransportType()
boolean	isUpgradedSession()
void	send(io.netty.buffer.ByteBuf message) Sends provided message's payload to client.

Method Detail

getSessionId

String getSessionId()

Returns session identifier.

getOrigin

String getOrigin()

Returns origin header of this session.

isUpgradedSession

boolean isUpgradedSession()

Returns:

if this flag is true it means that session was created in result of switching transport protocol (e.g. from WebSocket to XHR-Polling).

getUpgradedFromTransportType

TransportType getUpgradedFromTransportType()

Returns:

if that session was created in result of switching transport protocol (e.g. from WebSocket to XHR-Polling) it will return previous transport type. If this session isn't upgraded session it will return null.

getTransportType

TransportType getTransportType()

Returns transport type for this session (e.g. WebSocket or XHR-Polling).

getRemoteAddress

SocketAddress getRemoteAddress()

Returns remote address of the client.

getState

Session.State getState()

Returns session state (see Session.State).

getLocalPort

int getLocalPort()

Returns local port to which client connection is established.

send

void send(io.netty.buffer.ByteBuf message)

Sends provided message's payload to client. Passed ByteBuf will be released during sending operation.

Parameters:

message - message's payload to be sent to client

disconnect

void disconnect()

Disconnects this session