|
Interface Summary |
| ClientConfiguration |
The ClientConfiguration is a special kind of endpoint configuration object that contains
web socket configuration information specific only to client endpoints. |
| ClientContainer |
A ClientContainer is an implementation provided object that allows the developer to
initiate a web socket handshake from the provided endpoint. |
| ClientEndpointConfiguration |
The ClientEndpointConfiguration is a special kind of endpoint configuration object that contains
web socket configuration information specific only to client endpoints. |
| 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. |
| Decoder.Binary<T> |
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> |
This interface defines how a custom object is decoded from a web socket message in
the form of a binary stream. |
| Decoder.Text<T> |
This interface defines how a custom object is decoded from a web socket message in
the form of a string. |
| Decoder.TextStream<T> |
This interface defines how a custom object of type T is decoded from a web socket message in
the form of a character stream. |
| Encoder |
The Encoder interfaces defines how developers can provide a way to convert
their custom objects into web socket messages. |
| Encoder.Binary<T> |
This interface defines how to provide a way to convert a custom
object into a binary message. |
| Encoder.BinaryStream<T> |
This interface may be implemented by encoding algorithms
that want to write the encoded object to a binary stream. |
| Encoder.Text<T> |
This interface defines how to provide a way to convert a custom
object into a text message. |
| Encoder.TextStream<T> |
This interface may be implemented by encoding algorithms
that want to write the encoded object to a character stream. |
| EndpointConfiguration |
The endpoint configuration contains all the information needed during the handshake process
for this end point. |
| HandshakeRequest |
The handshake request represents the web socket defined Http request that for the opening
handshake of a web socket session. |
| HandshakeResponse |
The handshake response represents the web socket defined http response that will be
sent by the web socket server during the opening handshake. |
| MessageHandler |
Developers implement MessageHandlers in order to receive incoming messages
during a web socket conversation. |
| MessageHandler.AsyncBinary |
This kind of handler is called to process for binary messages which may arrive in multiple parts. |
| MessageHandler.AsyncText |
This kind of handler is called to process for text messages which may arrive in multiple parts. |
| MessageHandler.Binary |
This kind of listener listens for binary messages. |
| MessageHandler.BinaryStream |
This kind of handler is called when a new binary message arrives that is to be read using a blocking stream. |
| MessageHandler.CharacterStream |
This kind of handler is called when a new text message arrives that is to be read using a blocking stream. |
| MessageHandler.DecodedObject<T> |
This kind of listener listens for messages that the container knows how to decode into an object of type T. |
| MessageHandler.Pong |
This handler is called back by the container when the container receives a pong message. |
| MessageHandler.Text |
This kind of listener listens for text messages. |
| RemoteEndpoint<T> |
The RemoteEndpoint object is supplied by the container and represents the 'other end' of the Web Socket conversation. |
| SendHandler |
A simple callback object for asynchronous sending of web socket messages. |
| ServerConfiguration |
The ServerConfiguration is a special kind of endpoint configuration object that contains
web socket configuration information specific only to server endpoints. |
| ServerContainer |
The ServerContainer is an implementation provided object that, in addition
to being able to initiate web socket connections (client), can register endpoints
that can handle incoming connection requests. |
| ServerEndpointConfiguration |
The ServerEndpointConfiguration is a special kind of endpoint configuration object that contains
web socket configuration information specific only to server endpoints. |
| Session<T> |
A Web Socket session represents a conversation between two web socket endpoints. |
|
Class Summary |
| CloseReason |
A class encapsulating the reason why a web socket has been closed, or why it is being asked to
close. |
| ContainerProvider |
Provider class that uses the ServiceLoader mechanism to provide
implementations of ServerContainer and ClientContainer. |
| DefaultClientConfiguration |
The DefaultClientConfiguration is a concrete implementation of a client configuration. |
| DefaultServerConfiguration |
The DefaultServerConfiguration is a concrete class that embodies all the configuration
parameters for an endpoint that is to be published as a server endpoint. |
| Endpoint |
The Web Socket Endpoint represents and object that can handle web socket conversations. |
| SendResult |
The result of asynchronously sending a web socket message. |