- checkOrigin(String) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Check the value of the Origin header (
See Origin Header) the
client passed during the opening handshake.
- ClientEndpoint - Annotation Type in jakarta.websocket
-
The ClientEndpoint annotation a class level annotation is used to denote that a POJO is a web socket client and can
be deployed as such.
- ClientEndpointConfig - Interface in jakarta.websocket
-
The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration
information specific only to client endpoints.
- ClientEndpointConfig.Builder - Class in jakarta.websocket
-
The ClientEndpointConfig.Builder is a class used for creating
ClientEndpointConfig
objects for the
purposes of deploying a client endpoint.
- ClientEndpointConfig.Configurator - Class in jakarta.websocket
-
The Configurator class may be extended by developers who want to provide custom configuration algorithms, such as
intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each
endpoint instance configured with this configurator.
- close() - Method in interface jakarta.websocket.Session
-
Close the current conversation with a normal status code and no reason phrase.
- close(CloseReason) - Method in interface jakarta.websocket.Session
-
Close the current conversation, giving a reason for the closure.
- CloseReason - Class in jakarta.websocket
-
A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
- CloseReason(CloseReason.CloseCode, String) - Constructor for class jakarta.websocket.CloseReason
-
Creates a reason for closing a web socket connection with the given code and reason phrase.
- CloseReason.CloseCode - Interface in jakarta.websocket
-
A marker interface for the close codes.
- CloseReason.CloseCodes - Enum in jakarta.websocket
-
An Enumeration of status codes for a web socket close that are defined in the specification.
- configurator(ClientEndpointConfig.Configurator) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Sets the configurator object for the configuration this builder will build.
- Configurator() - Constructor for class jakarta.websocket.ClientEndpointConfig.Configurator
-
- configurator(ServerEndpointConfig.Configurator) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the custom configurator to use on the configuration object built by this builder.
- Configurator() - Constructor for class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
- connectToServer(Object, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied annotated endpoint instance to its server.
- connectToServer(Class<?>, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied annotated endpoint to its server.
- connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied programmatic client endpoint instance to its server with the given configuration.
- connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied programmatic endpoint to its server with the given configuration.
- ContainerProvider - Class in jakarta.websocket
-
Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
- ContainerProvider() - Constructor for class jakarta.websocket.ContainerProvider
-
- create() - Static method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Creates a new builder object with no subprotocols, extensions, encoders, decoders and a null
configurator.
- create(Class<?>, String) - Static method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the
relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom
configurator.
- decode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary
-
Decode the given bytes into an object of type T.
- decode(InputStream) - Method in interface jakarta.websocket.Decoder.BinaryStream
-
Decode the given bytes read from the input stream into an object of type T.
- decode(String) - Method in interface jakarta.websocket.Decoder.Text
-
Decode the given String into an object of type T.
- decode(Reader) - Method in interface jakarta.websocket.Decoder.TextStream
-
Reads the websocket message from the implementation provided Reader and decodes it into an instance of the
supplied object type.
- DecodeException - Exception in jakarta.websocket
-
A general exception that occurs when trying to decode a custom object from a text or binary message.
- DecodeException(ByteBuffer, String, Throwable) - Constructor for exception jakarta.websocket.DecodeException
-
Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause.
- DecodeException(String, String, Throwable) - Constructor for exception jakarta.websocket.DecodeException
-
Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause.
- DecodeException(ByteBuffer, String) - Constructor for exception jakarta.websocket.DecodeException
-
Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why.
- DecodeException(String, String) - Constructor for exception jakarta.websocket.DecodeException
-
Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why.
- Decoder - Interface in jakarta.websocket
-
The Decoder interface holds member interfaces that define how a developer can provide the web socket container a way
web socket messages into developer defined custom objects.
- Decoder.Binary<T> - Interface in jakarta.websocket
-
This interface defines how a custom object (of type T) is decoded from a web socket message in the form of a byte
buffer.
- Decoder.BinaryStream<T> - Interface in jakarta.websocket
-
This interface defines how a custom object is decoded from a web socket message in the form of a binary stream.
- Decoder.Text<T> - Interface in jakarta.websocket
-
This interface defines how a custom object is decoded from a web socket message in the form of a string.
- Decoder.TextStream<T> - Interface in jakarta.websocket
-
This interface defines how a custom object of type T is decoded from a web socket message in the form of a
character stream.
- decoders(List<Class<? extends Decoder>>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Assign the list of decoder implementation classes the client will use.
- decoders(List<Class<? extends Decoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the decoder implementation classes to use in the configuration.
- DeploymentException - Exception in jakarta.websocket
-
Checked exception indicating some kind of failure either to publish an endpoint on its server, or a failure to
connect a client to its server.
- DeploymentException(String) - Constructor for exception jakarta.websocket.DeploymentException
-
Creates a deployment exception with the given reason for the deployment failure.
- DeploymentException(String, Throwable) - Constructor for exception jakarta.websocket.DeploymentException
-
Creates a deployment exception with the given reason for the deployment failure and wrapped cause of the failure.
- destroy() - Method in interface jakarta.websocket.Decoder
-
This method is called when the decoder is about to be removed from service in order that any resources the
decoder used may be closed gracefully.
- destroy() - Method in interface jakarta.websocket.Encoder
-
This method is called when the encoder is about to be removed from service in order that any resources the
encoder used may be closed gracefully.
- encode(T) - Method in interface jakarta.websocket.Encoder.Binary
-
Encode the given object into a byte array.
- encode(T, OutputStream) - Method in interface jakarta.websocket.Encoder.BinaryStream
-
Encode the given object into a binary stream written to the implementation provided OutputStream.
- encode(T) - Method in interface jakarta.websocket.Encoder.Text
-
Encode the given object into a String.
- encode(T, Writer) - Method in interface jakarta.websocket.Encoder.TextStream
-
Encode the given object to a character stream writing it to the supplied Writer.
- EncodeException - Exception in jakarta.websocket
-
A general exception that occurs when trying to encode a custom object to a string or binary message.
- EncodeException(Object, String) - Constructor for exception jakarta.websocket.EncodeException
-
Constructor with the object being encoded, and the reason why it failed to be.
- EncodeException(Object, String, Throwable) - Constructor for exception jakarta.websocket.EncodeException
-
Constructor with the object being encoded, and the reason why it failed to be, and the cause.
- Encoder - Interface in jakarta.websocket
-
The Encoder interface defines how developers can provide a way to convert their custom objects into web socket
messages.
- Encoder.Binary<T> - Interface in jakarta.websocket
-
This interface defines how to provide a way to convert a custom object into a binary message.
- Encoder.BinaryStream<T> - Interface in jakarta.websocket
-
This interface may be implemented by encoding algorithms that want to write the encoded object to a binary
stream.
- Encoder.Text<T> - Interface in jakarta.websocket
-
This interface defines how to provide a way to convert a custom object into a text message.
- Encoder.TextStream<T> - Interface in jakarta.websocket
-
This interface may be implemented by encoding algorithms that want to write the encoded object to a character
stream.
- encoders(List<Class<? extends Encoder>>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Assign the list of encoder implementation classes the client will use.
- encoders(List<Class<? extends Encoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the list of encoder implementation classes for this builder.
- Endpoint - Class in jakarta.websocket
-
The Web Socket Endpoint represents an object that can handle websocket conversations.
- Endpoint() - Constructor for class jakarta.websocket.Endpoint
-
- EndpointConfig - Interface in jakarta.websocket
-
The endpoint configuration contains all the information needed during the handshake process for this end point.
- Extension - Interface in jakarta.websocket
-
A simple representation of a websocket extension as a name and map of extension parameters.
- Extension.Parameter - Interface in jakarta.websocket
-
This member interface defines a single websocket extension parameter.
- extensions(List<Extension>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Set the extensions for the configuration this builder will build.
- extensions(List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the extensions to use in the configuration.
- getAnnotatedEndpointClasses(Set<Class<?>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of annotated endpoint classes that the server container must deploy.
- getApplicationData() - Method in interface jakarta.websocket.PongMessage
-
The application data inside the pong message from the peer.
- getAsyncRemote() - Method in interface jakarta.websocket.Session
-
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send
messages asynchronously to the peer.
- getBasicRemote() - Method in interface jakarta.websocket.Session
-
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send
messages synchronously to the peer.
- getBatchingAllowed() - Method in interface jakarta.websocket.RemoteEndpoint
-
Return whether the implementation is allowed to batch outgoing messages before sending.
- getBytes() - Method in exception jakarta.websocket.DecodeException
-
Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, or
null
if this exception arose from a failure to decode a text message.
- getCloseCode(int) - Static method in enum jakarta.websocket.CloseReason.CloseCodes
-
Creates a CloseCode from the given int code number.
- getCloseCode() - Method in class jakarta.websocket.CloseReason
-
The Close code associated with this CloseReason.
- getCode() - Method in interface jakarta.websocket.CloseReason.CloseCode
-
Returns the code number, for example the integer '1000' for normal closure.
- getCode() - Method in enum jakarta.websocket.CloseReason.CloseCodes
-
Return the code number of this status code.
- getConfigurator() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the custom configurator for this configuration.
- getConfigurator() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
- getContainer() - Method in class jakarta.websocket.ContainerProvider
-
Create a new instance of the the WebSocket container implementation.
- getContainer() - Method in interface jakarta.websocket.Session
-
Return the container that this session is part of.
- getDecoders() - Method in interface jakarta.websocket.EndpointConfig
-
Return the Decoder implementation classes configured.
- getDefaultAsyncSendTimeout() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all
RemoteEndpoints associated with this container.
- getDefaultMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
-
Returns the default maximum size of incoming binary message that this container will buffer.
- getDefaultMaxSessionIdleTimeout() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the default time in milliseconds after which any web socket sessions in this container will be closed if
it has been inactive.
- getDefaultMaxTextMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
-
Returns the default maximum size of incoming text message that this container will buffer.
- getEncoders() - Method in interface jakarta.websocket.EndpointConfig
-
Return the Encoder implementation classes configured.
- getEndpointClass() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Returns the Class of the endpoint this configuration is configuring.
- getEndpointConfigs(Set<Class<? extends Endpoint>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of ServerEndpointConfig instances that the server container will use to deploy the programmatic
endpoints.
- getEndpointInstance(Class<T>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
This method is called by the container each time a new client connects to the logical endpoint this
configurator configures.
- getException() - Method in class jakarta.websocket.SendResult
-
The problem sending the message.
- getExtensions() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the extensions, in order of preference, favorite first, that this client would like to use for its
sessions.
- getExtensions() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket extensions configured.
- getHeaders() - Method in interface jakarta.websocket.HandshakeResponse
-
Return the map of HTTP headers to header values sent by the WebSocket server.
- getHeaders() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the read only map of HTTP headers to header values that came with the handshake request.
- getHttpSession() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return a reference to the HttpSession that the web socket handshake that started this conversation was part of,
if the implementation is part of a Java EE web container.
- getId() - Method in interface jakarta.websocket.Session
-
Returns a string containing the unique identifier assigned to this session.
- getInstalledExtensions() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the set of Extensions installed in the container.
- getMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.Session
-
The maximum length of incoming binary messages that this Session can buffer.
- getMaxIdleTimeout() - Method in interface jakarta.websocket.Session
-
Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.
- getMaxTextMessageBufferSize() - Method in interface jakarta.websocket.Session
-
The maximum length of incoming text messages that this Session can buffer.
- getMessageHandlers() - Method in interface jakarta.websocket.Session
-
Return an unmodifiable copy of the set of MessageHandlers for this Session.
- getName() - Method in interface jakarta.websocket.Extension
-
The name of the extension.
- getName() - Method in interface jakarta.websocket.Extension.Parameter
-
Return the name of the extension parameter.
- getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the ordered list of extensions that t server endpoint will support given the requested extension list
passed in, the empty list if none.
- getNegotiatedExtensions() - Method in interface jakarta.websocket.Session
-
Return the list of extensions currently in use for this conversation.
- getNegotiatedSubprotocol(List<String>, List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes
to connect, or none if there wasn't one this server endpoint liked.
- getNegotiatedSubprotocol() - Method in interface jakarta.websocket.Session
-
Return the sub protocol agreed during the websocket handshake for this conversation.
- getObject() - Method in exception jakarta.websocket.EncodeException
-
Return the Object that could not be encoded.
- getOpenSessions() - Method in interface jakarta.websocket.Session
-
Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to
which this session represents a connection.
- getParameterMap() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request parameters associated with the request.
- getParameters() - Method in interface jakarta.websocket.Extension
-
The extension parameters for this extension in the order they appear in the http headers.
- getPath() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the path for this endpoint configuration.
- getPathParameters() - Method in interface jakarta.websocket.Session
-
Return a map of the path parameter names and values used associated with the request this session was opened
under.
- getPreferredSubprotocols() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite
first that this client would like to use for its sessions.
- getProtocolVersion() - Method in interface jakarta.websocket.Session
-
Returns the version of the websocket protocol currently being used.
- getQueryString() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the query string associated with the request.
- getQueryString() - Method in interface jakarta.websocket.Session
-
Return the query string associated with the request this session was opened under.
- getReasonPhrase() - Method in class jakarta.websocket.CloseReason
-
The reason phrase associated with this CloseReason.
- getRequestParameterMap() - Method in interface jakarta.websocket.Session
-
Return the request parameters associated with the request this session was opened under.
- getRequestURI() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request URI of the handshake request.
- getRequestURI() - Method in interface jakarta.websocket.Session
-
Return the URI under which this session was opened, including the query string if there is one.
- getSendStream() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Opens an output stream on which a binary message may be sent.
- getSendTimeout() - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Return the number of milliseconds the implementation will timeout attempting to send a websocket message.
- getSendWriter() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Opens a character stream on which a text message may be sent.
- getSession() - Method in exception jakarta.websocket.SessionException
-
Return the Session on which the problem occurred.
- getSubprotocols() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket subprotocols configured.
- getText() - Method in exception jakarta.websocket.DecodeException
-
Return the encoded string that is either the whole message, or the partial message that could not be decoded, or
null
if this exception arose from a failure to decode a binary message..
- getUserPrincipal() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the authenticated user or null
if no user is authenticated for this handshake.
- getUserPrincipal() - Method in interface jakarta.websocket.Session
-
Return the authenticated user for this Session or null
if no user is authenticated for this session.
- getUserProperties() - Method in interface jakarta.websocket.EndpointConfig
-
This method returns a modifiable Map that the developer may use to store application specific information
relating to the endpoint that uses this configuration instance.
- getUserProperties() - Method in interface jakarta.websocket.Session
-
While the session is open, this method returns a Map that the developer may use to store application specific
information relating to this session instance.
- getValue() - Method in interface jakarta.websocket.Extension.Parameter
-
Return the value of the extension parameter.
- getWebSocketContainer() - Static method in class jakarta.websocket.ContainerProvider
-
Obtain a new instance of a WebSocketContainer.
- SEC_WEBSOCKET_ACCEPT - Static variable in interface jakarta.websocket.HandshakeResponse
-
The Sec-WebSocket-Accept header name.
- SEC_WEBSOCKET_EXTENSIONS - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Extensions header name
- SEC_WEBSOCKET_KEY - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Key header name
- SEC_WEBSOCKET_PROTOCOL - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Protocol header name
- SEC_WEBSOCKET_VERSION - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Version header name
- sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a binary message.
- sendBinary(ByteBuffer, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a binary message.
- sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a binary message, returning when all of the message has been transmitted.
- sendBinary(ByteBuffer, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a binary message in parts, blocking until all of the message has been transmitted.
- SendHandler - Interface in jakarta.websocket
-
A simple callback object for asynchronous sending of web socket messages.
- sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a custom developer object.
- sendObject(Object, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a custom developer object.
- sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Sends a custom developer object, blocking until it has been transmitted.
- sendPing(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint
-
Send a Ping message containing the given application data to the remote endpoint.
- sendPong(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint
-
Allows the developer to send an unsolicited Pong message containing the given application data in order to serve
as a unidirectional heartbeat for the session.
- SendResult - Class in jakarta.websocket
-
The result of asynchronously sending a web socket message.
- SendResult(Throwable) - Constructor for class jakarta.websocket.SendResult
-
Construct a SendResult carrying an exception.
- SendResult() - Constructor for class jakarta.websocket.SendResult
-
Construct a SendResult signifying a successful send carrying no exception.
- sendText(String, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a text message.
- sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a text message.
- sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a text message, blocking until all of the message has been transmitted.
- sendText(String, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a text message in parts, blocking until all of the message has been transmitted.
- ServerApplicationConfig - Interface in jakarta.websocket.server
-
Developers include implementations of ServerApplicationConfig in an archive containing websocket endpoints (WAR file,
or JAR file within the WAR file) in order to specify the websocket endpoints within the archive the implementation
must deploy.
- ServerContainer - Interface in jakarta.websocket.server
-
The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments.
- ServerEndpoint - Annotation Type in jakarta.websocket.server
-
This class level annotation declares that the class it decorates is a web socket endpoint that will be deployed and
made available in the URI-space of a web socket server.
- ServerEndpointConfig - Interface in jakarta.websocket.server
-
The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration
information specific only to server endpoints.
- ServerEndpointConfig.Builder - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Builder is a class used for creating
ServerEndpointConfig.Builder
objects for
the purposes of deploying a server endpoint.
- ServerEndpointConfig.Configurator - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Configurator class may be extended by developers who want to provide custom
configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and
algorithms that can be accessed from each endpoint instance configured with this configurator.
- Session - Interface in jakarta.websocket
-
A Web Socket session represents a conversation between two web socket endpoints.
- SessionException - Exception in jakarta.websocket
-
A SessionException represents a general exception type reporting problems occurring on a websocket session.
- SessionException(String, Throwable, Session) - Constructor for exception jakarta.websocket.SessionException
-
Creates a new instance of this exception with the given message, the wrapped cause of the exception and the
session with which the problem is associated.
- setAsyncSendTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all
RemoteEndpoints associated with this container.
- setBatchingAllowed(boolean) - Method in interface jakarta.websocket.RemoteEndpoint
-
Indicate to the implementation that it is allowed to batch outgoing messages before sending.
- setDefaultMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the default maximum size of incoming binary message that this container will buffer.
- setDefaultMaxSessionIdleTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it
has been inactive.
- setDefaultMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the maximum size of incoming text message that this container will buffer.
- setMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.Session
-
Sets the maximum length of incoming binary messages that this Session can buffer.
- setMaxIdleTimeout(long) - Method in interface jakarta.websocket.Session
-
Set the non-zero number of milliseconds before this session will be closed by the container if it is inactive, ie
no messages are either sent or received.
- setMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.Session
-
Sets the maximum length of incoming text messages that this Session can buffer.
- setSendTimeout(long) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Sets the number of milliseconds the implementation will timeout attempting to send a websocket message.
- subprotocols(List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the subprotocols to use in the configuration.