Package jakarta.websocket
Interface WebSocketContainer
-
- All Known Subinterfaces:
ServerContainer
public interface WebSocketContainer
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SessionconnectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path)Creates a new connection to the WebSocket.SessionconnectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path)SessionconnectToServer(java.lang.Class<? extends Endpoint> endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path)Creates a new connection to the WebSocket.SessionconnectToServer(java.lang.Object endpoint, java.net.URI path)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.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 Detail
-
getDefaultAsyncSendTimeout
long 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.
-
setAsyncSendTimeout
void 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
Session connectToServer(java.lang.Object endpoint, java.net.URI path) throws DeploymentException, java.io.IOException
- Throws:
DeploymentExceptionjava.io.IOException
-
connectToServer
Session connectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path) throws DeploymentException, java.io.IOException
- Throws:
DeploymentExceptionjava.io.IOException
-
connectToServer
Session connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path) throws DeploymentException, java.io.IOException
Creates a new connection to the WebSocket.- 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 establishedjava.io.IOException- If an I/O occurred while trying to establish the connection
-
connectToServer
Session connectToServer(java.lang.Class<? extends Endpoint> endpoint, ClientEndpointConfig clientEndpointConfiguration, java.net.URI path) throws DeploymentException, java.io.IOException
Creates a new connection to the WebSocket.- Parameters:
endpoint- 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 establishedjava.io.IOException- If an I/O occurred while trying to establish the connection
-
getDefaultMaxSessionIdleTimeout
long 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.
-
setDefaultMaxSessionIdleTimeout
void 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.
-
getDefaultMaxBinaryMessageBufferSize
int getDefaultMaxBinaryMessageBufferSize()
Get the default maximum buffer size for binary messages.- Returns:
- The current default maximum buffer size in bytes
-
setDefaultMaxBinaryMessageBufferSize
void setDefaultMaxBinaryMessageBufferSize(int max)
Set the default maximum buffer size for binary messages.- Parameters:
max- The new default maximum buffer size in bytes
-
getDefaultMaxTextMessageBufferSize
int getDefaultMaxTextMessageBufferSize()
Get the default maximum buffer size for text messages.- Returns:
- The current default maximum buffer size in characters
-
setDefaultMaxTextMessageBufferSize
void setDefaultMaxTextMessageBufferSize(int max)
Set the default maximum buffer size for text messages.- Parameters:
max- The new default maximum buffer size in characters
-
getInstalledExtensions
java.util.Set<Extension> getInstalledExtensions()
Get the installed extensions.- Returns:
- The set of extensions that are supported by this WebSocket implementation.
-
-