Package org.eclipse.jetty.websocket.api

Jetty WebSocket API

See: Description

Interface Summary

Interface	Description
RemoteEndpoint
Session	Session represents an active link of communications with a Remote WebSocket Endpoint.
SuspendToken	Connection suspend token
WebSocketConnectionListener	Core WebSocket Connection Listener
WebSocketFrameListener	WebSocket Frame Listener interface for incoming WebSocket frames.
WebSocketListener	Basic WebSocket Listener interface for incoming WebSocket message events.
WebSocketPartialListener	WebSocket Partial Message Listener interface for incoming WebSocket TEXT/BINARY/CONTINUATION frames.
WebSocketPingPongListener	WebSocket PING/PONG Listener interface for incoming WebSocket PING/PONG frames.
WriteCallback	Callback for Write events.

Class Summary

Class	Description
CloseStatus
StatusCode	The RFC 6455 specified status codes and IANA: WebSocket Close Code Number Registry
UpgradeRequest
UpgradeResponse
WebSocketAdapter	Default implementation of the WebSocketListener.
WebSocketPolicy	Settings for WebSocket operations.

Enum Summary

Enum	Description
BatchMode	The possible batch modes when invoking OutgoingFrames.outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame, WriteCallback, BatchMode).
WebSocketBehavior	Behavior for how the WebSocket should operate.

Exception Summary

Exception	Description
BadPayloadException	Exception to terminate the connection because it has received data within a frame payload that was not consistent with the requirements of that frame payload.
CloseException
InvalidWebSocketException	Indicating that the provided Class is not a valid WebSocket as defined by the API.
MessageTooLargeException	Exception when a message is too large for the internal buffers occurs and should trigger a connection close.
PolicyViolationException	Exception when a violation of policy occurs and should trigger a connection close.
ProtocolException	Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)
UpgradeException	Exception during WebSocket Upgrade Handshake.
WebSocketException	A recoverable exception within the websocket framework.
WebSocketTimeoutException	Exception thrown to indicate a connection I/O timeout.

Package org.eclipse.jetty.websocket.api Description

Jetty WebSocket API