All Classes and Interfaces
Class
Description
EventDriver is the main interface between the User's WebSocket POJO and the internal jetty implementation of WebSocket.
Basic scanner for Annotated Methods
Provides the implementation of
LogicalConnection within the framework of the new Connection framework of jetty-io.Deprecated.
Logic for working with the
Sec-WebSocket-Key and Sec-WebSocket-Accept headers.Static reference to a specific annotated classes metadata.
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.
Basic EndpointConfig (used when no EndpointConfig is provided or discovered)
The possible batch modes when invoking
OutgoingFrames.outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame, WriteCallback, BatchMode).Partial BINARY MessageAppender for MessageHandler.Partial interface
Partial BINARY MessageAppender for @
OnMessage annotated methodsExtends a
SharedBlockingCallback to a WebSocket WriteCallbackDefault implementation of the
Decoder.Text Message to Boolean decoder.Default encoder for
Boolean to Encoder.Text Message encoderDeprecated.
Default implementation of the
Decoder.Text Message to Byte decoderDefault encoder for
Byte to Encoder.Text Message encoderA Callable Method
Default implementation of the
Decoder.Text Message to Character decoderDefault encoder for
Character to Encoder.Text Message encoderContainer for Client use of the javax.websocket API.
Allowing a generate from a UpgradeRequest
The immutable base metadata for a coder (
Decoder or EncoderAn durable collection of
CoderMetadata.Tag indicating a component that needs to be configured.
Deprecated.
use
HttpClient with WebSocketClient directlyWebSocket Connection State.
The "Container Default Configurator" per the JSR-356 spec.
A Data Frame
Factory for
DecoderMetadataImmutable Metadata for a
DecoderImplementation of the
deflate-frame
extension seen out in the wild.
Default implementation of the
Decoder.Text Message to Double to decoderDefault encoder for
Double to Encoder.Text Message encoderThrown when a duplicate coder is encountered when attempting to identify a Endpoint's metadata (
Decoder or Encoder)A
Future<Void> that is already failed as a result of an Encode errorRepresents all of the declared
Encoders that the Container is aware of.Immutable Metadata for a
EncoderAssociate a JSR Endpoint with its optional
EndpointConfigCreate EventDriver implementations.
A specific implementation of a EventDriver.
A representation of the methods available to call for a particular class.
Interface for WebSocket Extensions.
Represents an Extension Configuration, as seen during the connection Handshake process.
Deprecated.
this class is removed from Jetty 10.0.0+
Represents the stack of Extensions.
Default implementation of the Text Message to
Float decoderDefault encoder for
Float to Encoder.Text Message encoderFragment Extension
An immutable websocket frame.
Allows events to a
WriteCallback to drive a Future for the user.Generating a frame in WebSocket land.
WebSocket Handshake for RFC 6455.
Responsible for reading UTF8 Response Header lines and parsing them into a provided UpgradeResponse object.
JSR-356 Parameter Identification processing.
Interface for dealing with Incoming Frames.
Exception during initialization of the Endpoint
Default implementation of the
Decoder.Text Message to Integer decoderDefault encoder for
Integer to Encoder.Text Message encoderIndicating that the provided Class is not a valid WebSocket as defined by the API.
Handler for Annotated User WebSocket objects.
Client
ContainerProvider implementation.Handler for
WebSocketListener based User WebSocket implementations.Base implementation for JSR-356 Annotated event drivers.
Event Driver for classes annotated with @
ClientEndpointEventDriver for websocket that extend from
EndpointThe live event methods found for a specific Annotated Endpoint
Common base for Parameter Identification in JSR Callable methods
Param handling for static Binary @
OnMessage parameters.Param handling for Text or Binary @
OnMessage parameters declared as DecodersParam handling for @
OnClose parameters.Param handling for @
OnError parameters.Param handling for @
OnOpen parameters.Param handling for static Text @
OnMessage parametersParam handling for static parameters annotated with @
PathParamEvent Driver for classes annotated with @
ServerEndpointSession for the JSR.
Default implementation of the Text Message to
Long decoderDefault encoder for
Long to Encoder.Text Message encoderCommon interface for MappedWebSocketCreator
Interface for various Masker implementations.
Appender for messages (used for multiple frames with continuations, and also to allow for streaming APIs)
Factory for
MessageHandlerMetadataAn immutable metadata for a
MessageHandler, representing a single interface on a message handling class.Expose a
MessageHandler instance along with its associated MessageHandlerMetadata and DecoderFactory.WrapperSupport class for reading a (single) WebSocket BINARY message via a InputStream.
Support for writing a single WebSocket BINARY message via a
OutputStreamSupport class for reading a (single) WebSocket TEXT message via a Reader.
Exception when a message is too large for the internal buffers occurs and should trigger a connection close.
Basic Message Type enum.
Support for writing a single WebSocket TEXT message via a
WriterInterface for Configuring Jetty Server Native WebSockets
WebSocket endpoint that does nothing.
Callable for
OnClose annotated methodsCallable for
OnError annotated methodsCallable for
OnMessage annotated methods with a whole or partial binary messages.Callable for
OnMessage annotated methods for InputStream based binary message objectsCallable for
OnMessage annotated methods with a PongMessage message object.Callable for
OnMessage annotated methods with a whole or partial text messages.Callable for
OnMessage annotated methods for Reader based text message objectsCallable for
OnOpen annotated methodsAnnotation for tagging methods to receive connection close events.
Annotation for tagging methods to receive connection open events.
Annotation for receiving websocket errors (exceptions) that have occurred internally in the websocket implementation.
(ADVANCED) Annotation for tagging methods to receive frame events.
Annotation for tagging methods to receive Binary or Text Message events.
Simple CallableMethod that manages the optional
Session argumentInterface for dealing with frames outgoing to (eventually) the network layer.
The various roles of the known parameters.
Simple class for representing a list of class arrays.
Parsing of a frames in WebSocket land.
Wrapper for a
ServerEndpointConfig where there is PathParam information from the incoming request.Deprecated.
moved to jetty-http
PathSpec (this facade will be removed in Jetty 9.4)Process the payload (for demasking, validating, etc..)
Per Message Deflate Compression extension for WebSocket.
Exception when a violation of policy occurs and should trigger a connection close.
Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)
Provide some consistent Http header value and Extension configuration parameter quoting support.
Immutable, Read-only, Frame implementation.
Deprecated.
moved to jetty-http
RegexPathSpec (this facade will be removed in Jetty 9.4)Deprecated.
moved to jetty-http
ServletPathSpec (this facade will be removed in Jetty 9.4)Servlet specific
UpgradeRequest implementation.Servlet Specific UpgradeResponse implementation.
Deprecated.
use
ServletUpgradeRequest insteadDeprecated.
use
ServletUpgradeResponse insteadSession represents an active link of communications with a Remote WebSocket Endpoint.
Interface for creating jetty
WebSocketSession objects.Default implementation of the
Decoder.Text Message to Short decoderDefault encoder for
Short to Encoder.Text Message encoderBasic
EndpointMetadata for an WebSocket that extends from EndpointDefault implementation of the
Decoder.Text Message to String decoderDefault encoder for
String to Encoder.Text Message encoderConnection suspend token
Partial TEXT MessageAppender for MessageHandler.Partial interface
Partial TEXT MessageAppender for @
OnMessage annotated methodsCollection of utility methods for Text content
Exception during WebSocket Upgrade Handshake.
Listener for Handshake/Upgrade events.
The HTTP Upgrade to WebSocket Request
The HTTP Upgrade to WebSocket Response
A CharBuffer wrapped with the Utf8Appendable logic.
Deprecated.
Tags a POJO as being a WebSocket class.
Default implementation of the
WebSocketListener.Behavior for how the WebSocket should operate.
WebSocketClient provides a means of establishing connections to remote websocket endpoints.
Client side WebSocket physical connection.
Core WebSocket Connection Listener
Defined Scope for a WebSocketContainer.
Abstract WebSocket creator interface.
A recoverable exception within the websocket framework.
A Base Frame as seen in RFC 6455.
WebSocket Frame Listener interface for incoming WebSocket frames.
Create a simple WebSocketHandler that registers a single WebSocket POJO that is created on every upgrade request.
Basic WebSocket Listener interface for incoming WebSocket message events.
WebSocket Partial Message Listener interface for incoming WebSocket TEXT/BINARY/CONTINUATION frames.
WebSocket PING/PONG Listener interface for incoming WebSocket PING/PONG frames.
Settings for WebSocket operations.
Endpoint for Writing messages to the Remote websocket.
DestroyListener
Factory to create WebSocket connections
Abstract Servlet used to bridge the Servlet API to the WebSocket API.
Basic WebSocketServletFactory for working with Jetty-based WebSocketServlets
Default Session factory, creating WebSocketSession objects.
Defined Scope for a WebSocketSession (active connection)
Exception thrown to indicate a connection I/O timeout.
Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to
WebSocketCreator objects.Callback for Write events.
Utility methods for converting a
URI between an HTTP(S) and WS(S) URI.Implementation of the x-webkit-deflate-frame extension seen out
in the wild.
ByteBufferAccumulatorinstead.