Uses of Package
jakarta.websocket

Packages that use jakarta.websocket
Package
Description
This package contains all the Jakarta WebSocket APIs common to both the client and server side.
This package contains all the Jakarta WebSocket APIs used only by server side applications.
Common Client.
Common Client Exceptions
Grizzly Client container.
Core classes.
Cluster relates classes and interfaces.
Encoder and decoder adapters and built-in implementations.
WebSocket Extension support.
WebSocket frame representations.
Server implementation.
Tyrus SPI.
  • Class
    Description
    The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
    The ClientEndpointConfig.Builder is a class used for creating ClientEndpointConfig objects for the purposes of deploying a client endpoint.
    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.
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
    A marker interface for the close codes.
    An Enumeration of status codes for a web socket close that are defined in the specification.
    A general exception that occurs when trying to decode a custom object from a text or binary message.
    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.
    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.
    A general exception that occurs when trying to encode a custom object to a string or binary message.
    The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
    The Web Socket Endpoint represents an object that can handle websocket conversations.
    The endpoint configuration contains all the information needed during the handshake process for this end point.
    A simple representation of a websocket extension as a name and map of extension parameters.
    This member interface defines a single websocket extension parameter.
    The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
    Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
    This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
    This kind of handler is notified by the container on arrival of a complete message.
    The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
    This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
    This representation of the peer of a web socket conversation has the ability to send messages synchronously.
    A simple callback object for asynchronous sending of web socket messages.
    The result of asynchronously sending a web socket message.
    A Web Socket session represents a conversation between two web socket endpoints.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    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.
    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.
    The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
    The Web Socket Endpoint represents an object that can handle websocket conversations.
    The endpoint configuration contains all the information needed during the handshake process for this end point.
    A simple representation of a websocket extension as a name and map of extension parameters.
    The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
    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.
    The Web Socket Endpoint represents an object that can handle websocket conversations.
    A simple representation of a websocket extension as a name and map of extension parameters.
    A Web Socket session represents a conversation between two web socket endpoints.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    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.
  • Class
    Description
    The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
    Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
    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.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
    A marker interface for the close codes.
    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.
    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.
    A general exception that occurs when trying to encode a custom object to a string or binary message.
    The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
    The Web Socket Endpoint represents an object that can handle websocket conversations.
    The endpoint configuration contains all the information needed during the handshake process for this end point.
    A simple representation of a websocket extension as a name and map of extension parameters.
    This member interface defines a single websocket extension parameter.
    The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
    Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
    This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
    This kind of handler is notified by the container on arrival of a complete message.
    The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
    This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
    This representation of the peer of a web socket conversation has the ability to send messages synchronously.
    A simple callback object for asynchronous sending of web socket messages.
    A Web Socket session represents a conversation between two web socket endpoints.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
    A simple representation of a websocket extension as a name and map of extension parameters.
    Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
    This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
    This kind of handler is notified by the container on arrival of a complete message.
    This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
    This representation of the peer of a web socket conversation has the ability to send messages synchronously.
    A simple callback object for asynchronous sending of web socket messages.
    A Web Socket session represents a conversation between two web socket endpoints.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    A general exception that occurs when trying to decode a custom object from a text or binary message.
    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.
    This interface defines how a custom object (of type T) is decoded from a web socket message in the form of a byte buffer.
    This interface defines how a custom object is decoded from a web socket message in the form of a string.
    A general exception that occurs when trying to encode a custom object to a string or binary message.
    The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
    This interface defines how to provide a way to convert a custom object into a binary message.
    This interface defines how to provide a way to convert a custom object into a text message.
    The endpoint configuration contains all the information needed during the handshake process for this end point.
  • Class
    Description
    A simple representation of a websocket extension as a name and map of extension parameters.
    This member interface defines a single websocket extension parameter.
  • Class
    Description
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
  • Class
    Description
    The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
    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.
    The Web Socket Endpoint represents an object that can handle websocket conversations.
    A simple representation of a websocket extension as a name and map of extension parameters.
    A Web Socket session represents a conversation between two web socket endpoints.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
  • Class
    Description
    The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
    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.
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
    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.
    The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
    A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.