Package org.apache.tomcat.websocket
Class WsWebSocketContainer
- java.lang.Object
-
- org.apache.tomcat.websocket.WsWebSocketContainer
-
- All Implemented Interfaces:
WebSocketContainer,BackgroundProcess
- Direct Known Subclasses:
WsServerContainer
public class WsWebSocketContainer extends java.lang.Object implements WebSocketContainer, BackgroundProcess
-
-
Constructor Summary
Constructors Constructor Description WsWebSocketContainer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbackgroundProcess()SessionconnectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path)SessionconnectToServer(java.lang.Class<? extends Endpoint> clazz, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path)Creates a new connection to the WebSocket.SessionconnectToServer(java.lang.Object pojo, java.net.URI path)SessionconnectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path)Creates a new connection to the WebSocket.voiddestroy()Cleans up the resources still in use by WebSocket sessions created from this container.longgetDefaultAsyncSendTimeout()Get the default timeout for sending a message asynchronously.intgetDefaultMaxBinaryMessageBufferSize()Get the default maximum buffer size for binary messages.longgetDefaultMaxSessionIdleTimeout()Get the current default session idle timeout.intgetDefaultMaxTextMessageBufferSize()Get the default maximum buffer size for text messages.java.util.Set<Extension>getInstalledExtensions()Get the installed extensions.protected InstanceManagergetInstanceManager(java.lang.ClassLoader classLoader)intgetProcessPeriod()The default value is 10 which means session expirations are processed every 10 seconds.protected voidregisterSession(java.lang.Object key, WsSession wsSession)voidsetAsyncSendTimeout(long timeout)Set the default timeout for sending a message asynchronously.voidsetDefaultMaxBinaryMessageBufferSize(int max)Set the default maximum buffer size for binary messages.voidsetDefaultMaxSessionIdleTimeout(long timeout)Set the default session idle timeout.voidsetDefaultMaxTextMessageBufferSize(int max)Set the default maximum buffer size for text messages.protected voidsetInstanceManager(InstanceManager instanceManager)voidsetProcessPeriod(int period)protected voidunregisterSession(java.lang.Object key, WsSession wsSession)
-
-
-
Method Detail
-
getInstanceManager
protected InstanceManager getInstanceManager(java.lang.ClassLoader classLoader)
-
setInstanceManager
protected void setInstanceManager(InstanceManager instanceManager)
-
connectToServer
public Session connectToServer(java.lang.Object pojo, java.net.URI path) throws DeploymentException
- Specified by:
connectToServerin interfaceWebSocketContainer- Throws:
DeploymentException
-
connectToServer
public Session connectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path) throws DeploymentException
- Specified by:
connectToServerin interfaceWebSocketContainer- Throws:
DeploymentException
-
connectToServer
public Session connectToServer(java.lang.Class<? extends Endpoint> clazz, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path) throws DeploymentException
Description copied from interface:javax.websocket.WebSocketContainerCreates a new connection to the WebSocket.- Specified by:
connectToServerin interfaceWebSocketContainer- Parameters:
clazz- An instance of this class will be created to handle responses from the serverclientEndpointConfiguration- Used to configure the new connectionpath- The full URL of the WebSocket endpoint to connect to- Returns:
- The WebSocket session for the connection
- Throws:
DeploymentException- If the connection cannot be established
-
connectToServer
public Session connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path) throws DeploymentException
Description copied from interface:javax.websocket.WebSocketContainerCreates a new connection to the WebSocket.- Specified by:
connectToServerin interfaceWebSocketContainer- Parameters:
endpoint- The endpoint instance that will handle responses from the serverclientEndpointConfiguration- Used to configure the new connectionpath- The full URL of the WebSocket endpoint to connect to- Returns:
- The WebSocket session for the connection
- Throws:
DeploymentException- If the connection cannot be established
-
registerSession
protected void registerSession(java.lang.Object key, WsSession wsSession)
-
unregisterSession
protected void unregisterSession(java.lang.Object key, WsSession wsSession)
-
getDefaultMaxSessionIdleTimeout
public long getDefaultMaxSessionIdleTimeout()
Description copied from interface:javax.websocket.WebSocketContainerGet the current default session idle timeout.- Specified by:
getDefaultMaxSessionIdleTimeoutin interfaceWebSocketContainer- Returns:
- The current default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.
-
setDefaultMaxSessionIdleTimeout
public void setDefaultMaxSessionIdleTimeout(long timeout)
Description copied from interface:javax.websocket.WebSocketContainerSet the default session idle timeout.- Specified by:
setDefaultMaxSessionIdleTimeoutin interfaceWebSocketContainer- Parameters:
timeout- The new default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.
-
getDefaultMaxBinaryMessageBufferSize
public int getDefaultMaxBinaryMessageBufferSize()
Description copied from interface:javax.websocket.WebSocketContainerGet the default maximum buffer size for binary messages.- Specified by:
getDefaultMaxBinaryMessageBufferSizein interfaceWebSocketContainer- Returns:
- The current default maximum buffer size in bytes
-
setDefaultMaxBinaryMessageBufferSize
public void setDefaultMaxBinaryMessageBufferSize(int max)
Description copied from interface:javax.websocket.WebSocketContainerSet the default maximum buffer size for binary messages.- Specified by:
setDefaultMaxBinaryMessageBufferSizein interfaceWebSocketContainer- Parameters:
max- The new default maximum buffer size in bytes
-
getDefaultMaxTextMessageBufferSize
public int getDefaultMaxTextMessageBufferSize()
Description copied from interface:javax.websocket.WebSocketContainerGet the default maximum buffer size for text messages.- Specified by:
getDefaultMaxTextMessageBufferSizein interfaceWebSocketContainer- Returns:
- The current default maximum buffer size in characters
-
setDefaultMaxTextMessageBufferSize
public void setDefaultMaxTextMessageBufferSize(int max)
Description copied from interface:javax.websocket.WebSocketContainerSet the default maximum buffer size for text messages.- Specified by:
setDefaultMaxTextMessageBufferSizein interfaceWebSocketContainer- Parameters:
max- The new default maximum buffer size in characters
-
getInstalledExtensions
public java.util.Set<Extension> getInstalledExtensions()
Get the installed extensions. Currently, this implementation does not support any extensions.- Specified by:
getInstalledExtensionsin interfaceWebSocketContainer- Returns:
- The set of extensions that are supported by this WebSocket implementation.
-
getDefaultAsyncSendTimeout
public long getDefaultAsyncSendTimeout()
Get the default timeout for sending a message asynchronously. The default value for this implementation is -1.- Specified by:
getDefaultAsyncSendTimeoutin interfaceWebSocketContainer- Returns:
- The current default timeout in milliseconds. A non-positive value means an infinite timeout.
-
setAsyncSendTimeout
public void setAsyncSendTimeout(long timeout)
Set the default timeout for sending a message asynchronously. The default value for this implementation is -1.- Specified by:
setAsyncSendTimeoutin interfaceWebSocketContainer- Parameters:
timeout- The new default timeout in milliseconds. A non-positive value means an infinite timeout.
-
destroy
public void destroy()
Cleans up the resources still in use by WebSocket sessions created from this container. This includes closing sessions and cancellingFutures associated with blocking read/writes.
-
backgroundProcess
public void backgroundProcess()
- Specified by:
backgroundProcessin interfaceBackgroundProcess
-
setProcessPeriod
public void setProcessPeriod(int period)
- Specified by:
setProcessPeriodin interfaceBackgroundProcess
-
getProcessPeriod
public int getProcessPeriod()
The default value is 10 which means session expirations are processed every 10 seconds.- Specified by:
getProcessPeriodin interfaceBackgroundProcess
-
-