Tyrus 2.2.0 · org.glassfish.tyrus.core.TyrusWebSocketEngine

Modifier and Type	Class and Description
private static class	TyrusWebSocketEngine.EndpointEventListenerWrapper Endpoint event listener wrapper that allows setting the wrapped endpoint event listener later.
private static class	TyrusWebSocketEngine.NoConnectionUpgradeInfo
private static class	TyrusWebSocketEngine.SuccessfulUpgradeInfo
pack-priv static class	TyrusWebSocketEngine.TyrusConnection
private static class	TyrusWebSocketEngine.TyrusReadHandler
public static class	TyrusWebSocketEngine.TyrusWebSocketEngineBuilder `org.glassfish.tyrus.core.TyrusWebSocketEngine` builder.

Field Summary

Modifier and Type	Field and Description
private final ApplicationEventListener	applicationEventListener
private static final int	BUFFER_STEP_SIZE
private final ClusterContext	clusterContext
private final ComponentProviderService	componentProviderService
private final Set<TyrusEndpointWrapper>	endpointWrappers
private static final WebSocketEngine.UpgradeInfo	HANDSHAKE_FAILED_UPGRADE_INFO
public static final String	INCOMING_BUFFER_SIZE Maximum size of incoming buffer in bytes.
private int	incomingBufferSize
private static final Logger	LOGGER
public static final String	MAX_SESSIONS_PER_APP Maximum number of open sessions per server application.
public static final String	MAX_SESSIONS_PER_REMOTE_ADDR Maximum number of open sessions per unique remote address.
private static final TyrusEndpointWrapper.SessionListener	NO_OP_SESSION_LISTENER
private static final WebSocketEngine.UpgradeInfo	NOT_APPLICABLE_UPGRADE_INFO
public static final String	PARALLEL_BROADCAST_ENABLED Parallel broadcast support.
private final Boolean	parallelBroadcastEnabled
private final TyrusEndpointWrapper.SessionListener	sessionListener
public static final String	TRACING_THRESHOLD Property used for configuring tracing threshold.
public static final String	TRACING_TYPE Property used for configuring the type of tracing supported by the server.
private final DebugContext.TracingThreshold	tracingThreshold
private final DebugContext.TracingType	tracingType
private final WebSocketContainer	webSocketContainer
public static final String	WSADL_SUPPORT Wsadl support.

Constructor Summary

Access Constructor and Description

private

Access	Constructor and Description
private	TyrusWebSocketEngine(WebSocketContainer used `WebSocketContainer` instance. webSocketContainer, Integer maximal incoming buffer size (this engine won't be able to process messages bigger than this number. If null, default value will be used). incomingBufferSize, ClusterContext cluster context instance. `null` indicates standalone mode. clusterContext, ApplicationEventListener listener used to collect monitored events. applicationEventListener, final Integer maximal number of open sessions per application. If `null`, no limit is applied. maxSessionsPerApp, final Integer maximal number of open sessions per remote address. If `null`, no limit is applied. maxSessionsPerRemoteAddr, DebugContext.TracingType type of tracing. tracingType, DebugContext.TracingThreshold tracing threshold. tracingThreshold, Boolean `true` if parallel broadcast should be enabled, `true` is default. parallelBroadcastEnabled) Create `WebSocketEngine` instance based on passed `WebSocketContainer` and with configured maximal incoming buffer size.

TyrusWebSocketEngine(WebSocketContainer

used WebSocketContainer instance.

webSocketContainer, Integer

maximal incoming buffer size (this engine won't be able to process messages bigger than this number. If null, default value will be used).

incomingBufferSize, ClusterContext

cluster context instance. null indicates standalone mode.

clusterContext, ApplicationEventListener

listener used to collect monitored events.

applicationEventListener, final Integer

maximal number of open sessions per application. If null, no limit is applied.

maxSessionsPerApp, final Integer

maximal number of open sessions per remote address. If null, no limit is applied.

maxSessionsPerRemoteAddr, DebugContext.TracingType

type of tracing.

tracingType, DebugContext.TracingThreshold

tracing threshold.

tracingThreshold, Boolean

true if parallel broadcast should be enabled, true is default.

parallelBroadcastEnabled)

Create WebSocketEngine instance based on passed WebSocketContainer and with configured maximal incoming buffer size.

Method Summary

Modifier and Type	Method and Description
public static TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	Returns: new builder. builder(WebSocketContainer `WebSocketContainer` instance. Cannot be `null`. webSocketContainer) Create `org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder` instance based on passed `WebSocketContainer`.
private void	checkPath(TyrusEndpointWrapper endpoint)
private DebugContext	createDebugContext(UpgradeRequest upgradeRequest)
public ApplicationEventListener	Returns: listener instance. getApplicationEventListener() Get `org.glassfish.tyrus.core.monitoring.ApplicationEventListener` related to current `org.glassfish.tyrus.core.TyrusWebSocketEngine` instance.
pack-priv TyrusEndpointWrapper	getEndpointWrapper(UpgradeRequest request, DebugContext debugContext)
public Application	Returns: application representing current set of deployed endpoints. getWsadlApplication() Get `org.glassfish.tyrus.core.wsadl.model.Application` representing current set of deployed endpoints.
private WebSocketEngine.UpgradeInfo	handleHandshakeException(HandshakeException handshakeException, UpgradeResponse response)
private static void	handleUnsupportedVersion(final UpgradeRequest request, UpgradeResponse response)
private static ProtocolHandler	loadHandler(UpgradeRequest request)
private void	logExtensionsAndSubprotocol(ProtocolHandler protocolHandler, DebugContext debugContext)
private void	register(TyrusEndpointWrapper the `TyrusEndpointWrapper` to register. endpointWrapper) Registers the specified `TyrusEndpointWrapper` with the `WebSocketEngine`.
public void	register(Class<?> endpoint class to be registered. endpointClass, String context path of the registered endpoint. contextPath) Implements org.glassfish.tyrus.spi.WebSocketEngine.register. Register endpoint class.
public void	register(ServerEndpointConfig server endpoint to be registered. serverConfig, String context path of the registered endpoint. contextPath) Implements org.glassfish.tyrus.spi.WebSocketEngine.register. Register `jakarta.websocket.server.ServerEndpointConfig`.
public void	setIncomingBufferSize(int buffer size in bytes. incomingBufferSize) Deprecated Please use `.TyrusWebSocketEngineBuilder#incomingBufferSize(Integer)` instead. Set incoming buffer size.
public void	unregister(TyrusEndpointWrapper the `TyrusEndpointWrapper` to un-register. endpointWrapper) Un-registers the specified `TyrusEndpointWrapper` with the `WebSocketEngine`.
public WebSocketEngine.UpgradeInfo	upgrade(final UpgradeRequest request to be upgraded. request, final UpgradeResponse response to the upgrade request. response) Implements org.glassfish.tyrus.spi.WebSocketEngine.upgrade. A transport calls this method to upgrade a HTTP request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class TyrusWebSocketEngine

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary