sirius.web.http

Interface WebsocketDispatcher

public interface WebsocketDispatcher

Provides a way to support websockets for the built-in web server.

Websocket support is done by creating a class implementing this interface. By placing an Register annotation is is found by the WebServerHandler which then initiates the websocket protocol for requests on the given uri.

Method Summary

Modifier and Type	Method and Description
WebsocketSession	createSession(ChannelHandlerContext ctx, HttpRequest req) Creates a new session for a given channel (context) and request.
String	getWebsocketUri() Returns the URI which is used to determine if a request is eligble for upgrading to web sockets.

Method Detail

getWebsocketUri

String getWebsocketUri()

Returns the URI which is used to determine if a request is eligble for upgrading to web sockets.

Returns:

the uri which is used to start websockets

createSession

WebsocketSession createSession(ChannelHandlerContext ctx,
                               HttpRequest req)

Creates a new session for a given channel (context) and request.

Parameters:

ctx - the channel which was used to initialize a websocket

req - the request which was made before upgrading to websockets

Returns:

a new session handling incoming and outgoing frames