org.glassfish.grizzly.websockets
Class WebSocketEngine

java.lang.Object
  org.glassfish.grizzly.websockets.WebSocketEngine

public class WebSocketEngine
extends Object

WebSockets engine implementation (singleton), which handles WebSocketApplications registration, responsible for client and server handshake validation.

Author:

Alexey Stashok.

See Also:

WebSocket, WebSocketApplication

Nested Class Summary

static class

WebSocketEngine.WebSocketHolder WebSocketHolder object, which gets associated with the Grizzly Connection.

Field Summary

static String	CONNECTION
static int	DEFAULT_TIMEOUT
static int	INITIAL_BUFFER_SIZE
static int	MASK_SIZE
static String	RESPONSE_CODE_MESSAGE
static int	RESPONSE_CODE_VALUE
static String	SEC_WS_ACCEPT
static String	SEC_WS_EXTENSIONS_HEADER
static String	SEC_WS_KEY_HEADER
static String	SEC_WS_ORIGIN_HEADER
static String	SEC_WS_PROTOCOL_HEADER
static String	SEC_WS_VERSION
static String	SERVER_KEY_HASH
static String	UPGRADE
static String	WEBSOCKET
static int	WS_VERSION

Method Summary

WebSocketApplication	getApplication(HttpRequestPacket request)
static WebSocketEngine	getEngine()
static boolean	isWebSocketEnabled()
void	register(String name, WebSocketApplication app)
void	register(WebSocketApplication app)
static void	setWebSocketEnabled(boolean webSocketEnabled)
void	unregister(WebSocketApplication app)
void	unregisterAll()
boolean	upgrade(FilterChainContext ctx, HttpRequestPacket request)

Methods inherited from class java.lang.Object

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

Field Detail

SEC_WS_ACCEPT

public static final String SEC_WS_ACCEPT

See Also:

Constant Field Values

SEC_WS_KEY_HEADER

public static final String SEC_WS_KEY_HEADER

See Also:

Constant Field Values

SEC_WS_ORIGIN_HEADER

public static final String SEC_WS_ORIGIN_HEADER

See Also:

Constant Field Values

SEC_WS_PROTOCOL_HEADER

public static final String SEC_WS_PROTOCOL_HEADER

See Also:

Constant Field Values

SEC_WS_EXTENSIONS_HEADER

public static final String SEC_WS_EXTENSIONS_HEADER

See Also:

Constant Field Values

SEC_WS_VERSION

public static final String SEC_WS_VERSION

See Also:

Constant Field Values

WEBSOCKET

public static final String WEBSOCKET

See Also:

Constant Field Values

RESPONSE_CODE_MESSAGE

public static final String RESPONSE_CODE_MESSAGE

See Also:

Constant Field Values

RESPONSE_CODE_VALUE

public static final int RESPONSE_CODE_VALUE

See Also:

Constant Field Values

UPGRADE

public static final String UPGRADE

See Also:

Constant Field Values

CONNECTION

public static final String CONNECTION

See Also:

Constant Field Values

WS_VERSION

public static final int WS_VERSION

See Also:

Constant Field Values

INITIAL_BUFFER_SIZE

public static final int INITIAL_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

SERVER_KEY_HASH

public static final String SERVER_KEY_HASH

See Also:

Constant Field Values

MASK_SIZE

public static final int MASK_SIZE

See Also:

Constant Field Values

Method Detail

isWebSocketEnabled

public static boolean isWebSocketEnabled()

Returns:

true is WebSockets are enabled.

setWebSocketEnabled

public static void setWebSocketEnabled(boolean webSocketEnabled)

getEngine

public static WebSocketEngine getEngine()

getApplication

public WebSocketApplication getApplication(HttpRequestPacket request)

upgrade

public boolean upgrade(FilterChainContext ctx,
                       HttpRequestPacket request)

register

public void register(String name,
                     WebSocketApplication app)

register

public void register(WebSocketApplication app)

unregister

public void unregister(WebSocketApplication app)

unregisterAll

public void unregisterAll()