sirius.web.http

Class WebsocketSession

java.lang.Object

sirius.web.http.WebsocketSession

public abstract class WebsocketSession
extends Object

Created per active websocket by a WebsocketDispatcher to handle incoming and outgoing traffic.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebsocketSession(ChannelHandlerContext ctx, HttpRequest request) Creates a new session for the given channel and request.

Method Summary

Modifier and Type	Method and Description
protected sirius.kernel.commons.Value	get(String key) Reads the given parameter from the query string of the underlying request.
protected sirius.kernel.commons.Value	getCookie(String key) Reads the given parameter from the query string of the underlying request.
abstract void	onFrame(WebSocketFrame frame) Invoked for each frame received via the websocket.
void	onWebsocketClosed() Tirggered when the websocket is closed.
void	onWebsocketOpened() Triggered when the websocket was sucessfully initialized.
void	sendMessage(String text) Sents a given string as text frame to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebsocketSession

protected WebsocketSession(ChannelHandlerContext ctx,
                           HttpRequest request)

Creates a new session for the given channel and request.

Parameters:

ctx - the channel (context) which started the websocket

request - the request made before upgrading to websocket

Method Detail

get

protected sirius.kernel.commons.Value get(String key)

Reads the given parameter from the query string of the underlying request.

Parameters:

key - the name of the parameter to fetch

Returns:

the value contained in the parameter

getCookie

protected sirius.kernel.commons.Value getCookie(String key)

Reads the given parameter from the query string of the underlying request.

Parameters:

key - the name of the parameter to fetch

Returns:

the value contained in the parameter

onWebsocketOpened

public void onWebsocketOpened()

Triggered when the websocket was sucessfully initialized.

onWebsocketClosed

public void onWebsocketClosed()

Tirggered when the websocket is closed.

onFrame

public abstract void onFrame(WebSocketFrame frame)

Invoked for each frame received via the websocket.

Parameters:

frame - the received frame

sendMessage

public void sendMessage(String text)

Sents a given string as text frame to the client.

Parameters:

text - the string to send