io.scalecube.socketio.session

Interface ManagedSession

All Superinterfaces:

Session

All Known Implementing Classes:

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

public interface ManagedSession
extends Session

This interface enrich ISession interface with control methods required to manage session internally. This interface is not supposed to be used by users of the library and represents internal details session implementation and subject to change in future versions.

Author:

Anton Kharenko

Nested Class Summary

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

Session.State

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.
void	markAsUpgraded() Marks session as upgraded when session is going to be upgraded to another transport type.
void	sendHeartbeat() Send heartbeat packet to client.
void	sendPacket(Packet messagePacket) Send packet message to client.

Methods inherited from interface io.scalecube.socketio.Session

disconnect, getLocalPort, getOrigin, getRemoteAddress, getSessionId, getState, getTransportType, getUpgradedFromTransportType, isUpgradedSession, send

Method Detail

connect

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

Connects current session to given channel.

Parameters:

channel - channel to which client connected

Returns:

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

disconnect

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

Disconnect this session.

Parameters:

channel - the channel to use for disconnection

sendHeartbeat

void sendHeartbeat()

Send heartbeat packet to client.

sendPacket

void sendPacket(Packet messagePacket)

Send packet message to client.

Parameters:

messagePacket - message to be sent to client

acceptPacket

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

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

Parameters:

channel - channel to which client connected

acceptHeartbeat

void acceptHeartbeat()

Reschedule heartbeats for this client.

markAsUpgraded

void markAsUpgraded()

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