org.glassfish.tyrus.spi

Interface WebSocketEngine

public interface WebSocketEngine

WebSocket engine is used for upgrading HTTP requests into websocket connections. A transport gets hold of the engine from the ServerContainer and upgrades HTTP handshake requests.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebSocketEngine.UpgradeInfo Upgrade info that includes status for HTTP request upgrading and connection creation details.
static class	WebSocketEngine.UpgradeStatus Upgrade Status for HTTP request upgrading

Method Summary

Methods

Modifier and Type	Method and Description
void	register(Class<?> endpointClass, String contextPath)
void	register(javax.websocket.server.ServerEndpointConfig serverConfig, String contextPath)
WebSocketEngine.UpgradeInfo	upgrade(UpgradeRequest request, UpgradeResponse response) A transport calls this method to upgrade a HTTP request.

Method Detail

upgrade

WebSocketEngine.UpgradeInfo upgrade(UpgradeRequest request,
                                  UpgradeResponse response)

A transport calls this method to upgrade a HTTP request.

Returns:

info about upgrade status and connection details.

register

void register(Class<?> endpointClass,
            String contextPath)
              throws javax.websocket.DeploymentException

Throws:

javax.websocket.DeploymentException

register

void register(javax.websocket.server.ServerEndpointConfig serverConfig,
            String contextPath)
              throws javax.websocket.DeploymentException

Throws:

javax.websocket.DeploymentException