Package jakarta.websocket
Interface WebSocketContainer
- All Known Subinterfaces:
- ServerContainer
public interface WebSocketContainer
- 
Method SummaryModifier and TypeMethodDescriptionconnectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) Creates a new connection to the WebSocket.connectToServer(Class<?> annotatedEndpointClass, URI path) connectToServer(Class<? extends Endpoint> endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) Creates a new connection to the WebSocket.connectToServer(Object endpoint, URI path) longGet the default timeout for sending a message asynchronously.intGet the default maximum buffer size for binary messages.longGet the current default session idle timeout.intGet the default maximum buffer size for text messages.Get the installed extensions.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.
- 
Method Details- 
getDefaultAsyncSendTimeoutlong getDefaultAsyncSendTimeout()Get the default timeout for sending a message asynchronously.- Returns:
- The current default timeout in milliseconds. A non-positive value means an infinite timeout.
 
- 
setAsyncSendTimeoutvoid setAsyncSendTimeout(long timeout) Set the default timeout for sending a message asynchronously.- Parameters:
- timeout- The new default timeout in milliseconds. A non-positive value means an infinite timeout.
 
- 
connectToServer- Throws:
- DeploymentException
- IOException
 
- 
connectToServerSession connectToServer(Class<?> annotatedEndpointClass, URI path) throws DeploymentException, IOException - Throws:
- DeploymentException
- IOException
 
- 
connectToServerSession connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException, IOException Creates a new connection to the WebSocket.- Parameters:
- endpoint- The endpoint instance that will handle responses from the server
- clientEndpointConfiguration- Used to configure the new connection
- path- 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
- IOException- If an I/O occurred while trying to establish the connection
 
- 
connectToServerSession connectToServer(Class<? extends Endpoint> endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException, IOException Creates a new connection to the WebSocket.- Parameters:
- endpoint- An instance of this class will be created to handle responses from the server
- clientEndpointConfiguration- Used to configure the new connection
- path- 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
- IOException- If an I/O occurred while trying to establish the connection
 
- 
getDefaultMaxSessionIdleTimeoutlong getDefaultMaxSessionIdleTimeout()Get the current default session idle timeout.- Returns:
- The current default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
setDefaultMaxSessionIdleTimeoutvoid setDefaultMaxSessionIdleTimeout(long timeout) Set the default session idle timeout.- Parameters:
- timeout- The new default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
getDefaultMaxBinaryMessageBufferSizeint getDefaultMaxBinaryMessageBufferSize()Get the default maximum buffer size for binary messages.- Returns:
- The current default maximum buffer size in bytes
 
- 
setDefaultMaxBinaryMessageBufferSizevoid setDefaultMaxBinaryMessageBufferSize(int max) Set the default maximum buffer size for binary messages.- Parameters:
- max- The new default maximum buffer size in bytes
 
- 
getDefaultMaxTextMessageBufferSizeint getDefaultMaxTextMessageBufferSize()Get the default maximum buffer size for text messages.- Returns:
- The current default maximum buffer size in characters
 
- 
setDefaultMaxTextMessageBufferSizevoid setDefaultMaxTextMessageBufferSize(int max) Set the default maximum buffer size for text messages.- Parameters:
- max- The new default maximum buffer size in characters
 
- 
getInstalledExtensionsGet the installed extensions.- Returns:
- The set of extensions that are supported by this WebSocket implementation.
 
 
-