Uses of Package
jakarta.websocket

Packages that use jakarta.websocket

Package	Description
jakarta.websocket	This package contains all the Jakartq WebSocket APIs common to both the client and server side.
jakarta.websocket.server	This package contains all the Jakarta WebSocket APIs used only by server side applications.
org.glassfish.tyrus.client	Common Client.
org.glassfish.tyrus.client.exception	Common Client Exceptions
org.glassfish.tyrus.container.grizzly.client	Grizzly Client container.
org.glassfish.tyrus.core	Core classes.
org.glassfish.tyrus.core.cluster	Cluster relates classes and interfaces.
org.glassfish.tyrus.core.coder	Encoder and decoder adapters and built-in implementations.
org.glassfish.tyrus.core.extension	WebSocket Extension support.
org.glassfish.tyrus.core.frame	WebSocket frame representations.
org.glassfish.tyrus.server	Server implementation.
org.glassfish.tyrus.spi	Tyrus SPI.

Classes in jakarta.websocket used by jakarta.websocket

Class and Description
ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
ClientEndpointConfig.Builder The ClientEndpointConfig.Builder is a class used for creating ClientEndpointConfig objects for the purposes of deploying a client endpoint.
ClientEndpointConfig.Configurator 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.
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
CloseReason.CloseCode A marker interface for the close codes.
CloseReason.CloseCodes An Enumeration of status codes for a web socket close that are defined in the specification.
DecodeException A general exception that occurs when trying to decode a custom object from a text or binary message.
Decoder 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.
DeploymentException 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.
EncodeException A general exception that occurs when trying to encode a custom object to a string or binary message.
Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
EndpointConfig The endpoint configuration contains all the information needed during the handshake process for this end point.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
Extension.Parameter This member interface defines a single websocket extension parameter.
HandshakeResponse The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
MessageHandler Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
MessageHandler.Partial This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
MessageHandler.Whole This kind of handler is notified by the container on arrival of a complete message.
RemoteEndpoint The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
RemoteEndpoint.Async This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
RemoteEndpoint.Basic This representation of the peer of a web socket conversation has the ability to send messages synchronously.
SendHandler A simple callback object for asynchronous sending of web socket messages.
SendResult The result of asynchronously sending a web socket message.
Session A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by jakarta.websocket.server

Class and Description
Decoder 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.
DeploymentException 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.
Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
EndpointConfig The endpoint configuration contains all the information needed during the handshake process for this end point.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
HandshakeResponse The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.client

Class and Description
ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
DeploymentException 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.
Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
Session A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.client.exception

Class and Description
DeploymentException 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.

Classes in jakarta.websocket used by org.glassfish.tyrus.container.grizzly.client

Class and Description
ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
ContainerProvider Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
DeploymentException 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.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.core

Class and Description
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
CloseReason.CloseCode A marker interface for the close codes.
Decoder 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.
DeploymentException 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.
EncodeException A general exception that occurs when trying to encode a custom object to a string or binary message.
Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
EndpointConfig The endpoint configuration contains all the information needed during the handshake process for this end point.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
Extension.Parameter This member interface defines a single websocket extension parameter.
HandshakeResponse The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
MessageHandler Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
MessageHandler.Partial This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
MessageHandler.Whole This kind of handler is notified by the container on arrival of a complete message.
RemoteEndpoint The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
RemoteEndpoint.Async This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
RemoteEndpoint.Basic This representation of the peer of a web socket conversation has the ability to send messages synchronously.
SendHandler A simple callback object for asynchronous sending of web socket messages.
Session A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.core.cluster

Class and Description
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
MessageHandler Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
MessageHandler.Partial This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
MessageHandler.Whole This kind of handler is notified by the container on arrival of a complete message.
RemoteEndpoint.Async This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
RemoteEndpoint.Basic This representation of the peer of a web socket conversation has the ability to send messages synchronously.
SendHandler A simple callback object for asynchronous sending of web socket messages.
Session A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.core.coder

Class and Description
DecodeException A general exception that occurs when trying to decode a custom object from a text or binary message.
Decoder 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 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.Text This interface defines how a custom object is decoded from a web socket message in the form of a string.
EncodeException A general exception that occurs when trying to encode a custom object to a string or binary message.
Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
Encoder.Binary This interface defines how to provide a way to convert a custom object into a binary message.
Encoder.Text This interface defines how to provide a way to convert a custom object into a text message.
EndpointConfig The endpoint configuration contains all the information needed during the handshake process for this end point.

Classes in jakarta.websocket used by org.glassfish.tyrus.core.extension

Class and Description
Extension A simple representation of a websocket extension as a name and map of extension parameters.
Extension.Parameter This member interface defines a single websocket extension parameter.

Classes in jakarta.websocket used by org.glassfish.tyrus.core.frame

Class and Description
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.

Classes in jakarta.websocket used by org.glassfish.tyrus.server

Class and Description
ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
DeploymentException 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.
Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
Extension A simple representation of a websocket extension as a name and map of extension parameters.
Session A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Classes in jakarta.websocket used by org.glassfish.tyrus.spi

Class and Description
ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
ClientEndpointConfig.Configurator 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.
CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
DeploymentException 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.
HandshakeResponse The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.