javax.websocket (Java(TM) EE 7 Specification APIs) (original) (raw)

ClientEndpointConfig

The ClientEndpointConfig 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

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

This interface defines how a custom object is decoded from a web socket message in the form of a binary stream.

Decoder.Text

This interface defines how a custom object is decoded from a web socket message in the form of a string.

Decoder.TextStream

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 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.BinaryStream

This interface may be implemented by encoding algorithms that want to write the encoded object to a binary stream.

Encoder.Text

This interface defines how to provide a way to convert a custom object into a text message.

Encoder.TextStream

This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream.

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 web socket-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.

PongMessage

The PongMessage interface represents a web socket pong.

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.