public class WebSocketEngine extends Object
WebSocketApplication
s registration, responsible
for client and server handshake validation.WebSocket
,
WebSocketApplication
Modifier and Type | Class and Description |
---|---|
static class |
WebSocketEngine.WebSocketHolder
WebSocketHolder object, which gets associated with the Grizzly
Connection . |
Modifier and Type | Field and Description |
---|---|
static String |
CLIENT_WS_ORIGIN_HEADER |
static String |
CONNECTION |
static int |
DEFAULT_TIMEOUT |
static Version |
DEFAULT_VERSION |
static int |
INITIAL_BUFFER_SIZE |
static int |
MASK_SIZE |
static String |
ORIGIN_HEADER |
static String |
RESPONSE_CODE_HEADER |
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 |
Modifier and Type | Method and Description |
---|---|
WebSocketApplication |
getApplication(HttpRequestPacket request) |
static WebSocketEngine |
getEngine() |
WebSocket |
getWebSocket(Connection connection)
Get the
WebSocket associated with the Grizzly Connection , or null, if there none is
associated. |
WebSocketEngine.WebSocketHolder |
getWebSocketHolder(Connection connection) |
static ProtocolHandler |
loadHandler(MimeHeaders headers) |
void |
register(String contextPath,
String urlPattern,
WebSocketApplication app)
Register a WebSocketApplication to a specific context path and url pattern.
|
void |
register(WebSocketApplication app)
Deprecated.
|
WebSocketEngine.WebSocketHolder |
setWebSocketHolder(Connection connection,
ProtocolHandler handler,
WebSocket socket) |
static byte[] |
toArray(long length) |
static long |
toLong(byte[] bytes,
int start,
int end) |
static List<String> |
toString(byte[] bytes) |
static List<String> |
toString(byte[] bytes,
int start,
int end) |
void |
unregister(WebSocketApplication app) |
void |
unregisterAll()
Un-registers all
WebSocketApplication instances with the
WebSocketEngine . |
boolean |
upgrade(FilterChainContext ctx,
HttpContent requestContent) |
public static final String SEC_WS_ACCEPT
public static final String SEC_WS_KEY_HEADER
public static final String SEC_WS_ORIGIN_HEADER
public static final String ORIGIN_HEADER
public static final String SEC_WS_PROTOCOL_HEADER
public static final String SEC_WS_EXTENSIONS_HEADER
public static final String SEC_WS_VERSION
public static final String WEBSOCKET
public static final String RESPONSE_CODE_MESSAGE
public static final String RESPONSE_CODE_HEADER
public static final int RESPONSE_CODE_VALUE
public static final String UPGRADE
public static final String CONNECTION
public static final String CLIENT_WS_ORIGIN_HEADER
public static final Version DEFAULT_VERSION
public static final int INITIAL_BUFFER_SIZE
public static final int DEFAULT_TIMEOUT
public static final String SERVER_KEY_HASH
public static final int MASK_SIZE
public static WebSocketEngine getEngine()
public static byte[] toArray(long length)
public static long toLong(byte[] bytes, int start, int end)
public WebSocketApplication getApplication(HttpRequestPacket request)
public boolean upgrade(FilterChainContext ctx, HttpContent requestContent) throws IOException
IOException
public static ProtocolHandler loadHandler(MimeHeaders headers)
public void register(String contextPath, String urlPattern, WebSocketApplication app)
Examples: // WS application will be invoked: // ws://localhost:8080/echo // WS application will not be invoked: // ws://localhost:8080/foo/echo // ws://localhost:8080/echo/some/path register("", "/echo", webSocketApplication); // WS application will be invoked: // ws://localhost:8080/echo // ws://localhost:8080/echo/some/path // WS application will not be invoked: // ws://localhost:8080/foo/echo register("", "/echo/*", webSocketApplication); // WS application will be invoked: // ws://localhost:8080/context/echo // WS application will not be invoked: // ws://localhost:8080/echo // ws://localhost:8080/context/some/path register("/context", "/echo", webSocketApplication);
contextPath
- the context path (per servlet rules)urlPattern
- url pattern (per servlet rules)app
- the WebSocket application.@Deprecated public void register(WebSocketApplication app)
register(String, String, WebSocketApplication)
public void unregister(WebSocketApplication app)
public void unregisterAll()
WebSocketApplication
instances with the
WebSocketEngine
.public WebSocket getWebSocket(Connection connection)
WebSocket
associated with the Grizzly Connection
, or null, if there none is
associated.connection
- Grizzly Connection
.WebSocket
associated with the Grizzly Connection
, or null, if there none is
associated.public WebSocketEngine.WebSocketHolder getWebSocketHolder(Connection connection)
public WebSocketEngine.WebSocketHolder setWebSocketHolder(Connection connection, ProtocolHandler handler, WebSocket socket)
Copyright © 2013 Oracle Corporation. All Rights Reserved.