io.scalecube.socketio.session

Class AbstractSession

java.lang.Object

io.scalecube.socketio.session.AbstractSession

All Implemented Interfaces:

Session, ManagedSession

Direct Known Subclasses:

AbstractPollingSession, AbstractSocketSession

public abstract class AbstractSession
extends Object
implements ManagedSession

Nested Class Summary

Nested classes/interfaces inherited from interface io.scalecube.socketio.Session

Session.State

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionDisconnectHandler	disconnectHandler
protected SocketIOHeartbeatScheduler	heartbeatScheduler

Constructor Summary

Constructors

Constructor and Description
AbstractSession(io.netty.channel.Channel channel, String sessionId, String origin, SessionDisconnectHandler disconnectHandler, TransportType upgradedFromTransportType, int localPort, SocketAddress remoteAddress)

Method Summary

Modifier and Type	Method and Description
void	acceptHeartbeat() Reschedule heartbeats for this client.
void	acceptPacket(io.netty.channel.Channel channel, Packet packet) Send acknowledgment (e.g.
boolean	connect(io.netty.channel.Channel channel) Connects current session to given channel.
void	disconnect(io.netty.channel.Channel channel) Disconnect this session.
protected void	fillPacketHeaders(IPacket packet)
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	getUpgradedFromTransportType()
protected boolean	isUpgraded()
boolean	isUpgradedSession()
void	markAsUpgraded() Marks session as upgraded when session is going to be upgraded to another transport type.
void	send(io.netty.buffer.ByteBuf message) Sends provided message's payload to client.
void	sendHeartbeat() Send heartbeat packet to client.
protected void	sendPacketToChannel(io.netty.channel.Channel channel, IPacket packet)
protected Session.State	setState(Session.State state)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.scalecube.socketio.session.ManagedSession

sendPacket

Methods inherited from interface io.scalecube.socketio.Session

disconnect, getTransportType

Field Detail

disconnectHandler

protected final SessionDisconnectHandler disconnectHandler

heartbeatScheduler

protected final SocketIOHeartbeatScheduler heartbeatScheduler

Constructor Detail

AbstractSession

public AbstractSession(io.netty.channel.Channel channel,
                       String sessionId,
                       String origin,
                       SessionDisconnectHandler disconnectHandler,
                       TransportType upgradedFromTransportType,
                       int localPort,
                       SocketAddress remoteAddress)

Method Detail

getSessionId

public final String getSessionId()

Description copied from interface: Session

Returns session identifier.

Specified by:

getSessionId in interface Session

isUpgradedSession

public final boolean isUpgradedSession()

Specified by:

isUpgradedSession in interface Session

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

public TransportType getUpgradedFromTransportType()

Specified by:

getUpgradedFromTransportType in interface Session

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.

getRemoteAddress

public final SocketAddress getRemoteAddress()

Description copied from interface: Session

Returns remote address of the client.

Specified by:

getRemoteAddress in interface Session

getOrigin

public final String getOrigin()

Description copied from interface: Session

Returns origin header of this session.

Specified by:

getOrigin in interface Session

getLocalPort

public int getLocalPort()

Description copied from interface: Session

Returns local port to which client connection is established.

Specified by:

getLocalPort in interface Session

isUpgraded

protected boolean isUpgraded()

getState

public Session.State getState()

Description copied from interface: Session

Returns session state (see Session.State).

Specified by:

getState in interface Session

connect

public boolean connect(io.netty.channel.Channel channel)

Description copied from interface: ManagedSession

Connects current session to given channel.

Specified by:

connect in interface ManagedSession

Parameters:

channel - channel to which client connected

Returns:

true if this is initial connection for this session; false otherwise.

disconnect

public void disconnect(io.netty.channel.Channel channel)

Description copied from interface: ManagedSession

Disconnect this session.

Specified by:

disconnect in interface ManagedSession

Parameters:

channel - the channel to use for disconnection

sendHeartbeat

public void sendHeartbeat()

Description copied from interface: ManagedSession

Send heartbeat packet to client.

Specified by:

sendHeartbeat in interface ManagedSession

send

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

Description copied from interface: Session

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

Specified by:

send in interface Session

Parameters:

message - message's payload to be sent to client

sendPacketToChannel

protected void sendPacketToChannel(io.netty.channel.Channel channel,
                                   IPacket packet)

acceptPacket

public void acceptPacket(io.netty.channel.Channel channel,
                         Packet packet)

Description copied from interface: ManagedSession

Send acknowledgment (e.g. HTTP 200) to client that message was accepted

Specified by:

acceptPacket in interface ManagedSession

Parameters:

channel - channel to which client connected

markAsUpgraded

public void markAsUpgraded()

Description copied from interface: ManagedSession

Marks session as upgraded when session is going to be upgraded to another transport type.

Specified by:

markAsUpgraded in interface ManagedSession

acceptHeartbeat

public void acceptHeartbeat()

Description copied from interface: ManagedSession

Reschedule heartbeats for this client.

Specified by:

acceptHeartbeat in interface ManagedSession

fillPacketHeaders

protected void fillPacketHeaders(IPacket packet)

setState

protected Session.State setState(Session.State state)

toString

public String toString()

Overrides:

toString in class Object