Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABNORMAL - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
Abnormal Close is a synonym for
StatusCode.NO_CLOSE
, used to indicate a close condition where no close frame was processed from the remote side. - Abstract() - Constructor for class org.eclipse.jetty.websocket.api.Session.Listener.Abstract
- AbstractAutoDemanding() - Constructor for class org.eclipse.jetty.websocket.api.Session.Listener.AbstractAutoDemanding
- addSessionListener(WebSocketSessionListener) - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
Register a WebSocketSessionListener with the container
- asBiConsumer() - Method in interface org.eclipse.jetty.websocket.api.Callback
-
Converts this callback into a
BiConsumer
that can be passed toCompletableFuture.whenComplete(BiConsumer)
. - autoDemand() - Element in annotation interface org.eclipse.jetty.websocket.api.annotations.WebSocket
-
Returns whether demand for WebSocket frames is automatically performed upon successful return from methods annotated with
OnWebSocketOpen
,OnWebSocketFrame
andOnWebSocketMessage
.
B
- BAD_DATA - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
- BAD_PAYLOAD - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).
- BadPayloadException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
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.
- BadPayloadException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- BadPayloadException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- BadPayloadException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- BINARY - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
C
- Callback - Interface in org.eclipse.jetty.websocket.api
-
A callback object that handles success/failure events of asynchronous operations.
- Callback.Completable - Class in org.eclipse.jetty.websocket.api
-
A
Callback
that is also aCompletableFuture
. - close() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Equivalent to
close(StatusCode.NORMAL, null, Callback.NOOP)
. - close(int, String, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Sends a websocket CLOSE frame, with status code and reason, notifying the given callback when the frame send is completed, either successfully or with a failure.
- CLOSE - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
- CloseException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
- CloseException(int, String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.CloseException
- CloseException(int, String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.CloseException
- CloseException(int, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.CloseException
- Completable() - Constructor for class org.eclipse.jetty.websocket.api.Callback.Completable
- compose(Consumer<Callback.Completable>) - Method in class org.eclipse.jetty.websocket.api.Callback.Completable
-
Returns a new
Callback.Completable
that, when thisCallback.Completable
succeeds, is passed to the given consumer and then returned. - Configurable - Interface in org.eclipse.jetty.websocket.api
-
Implementations allow to configure WebSocket parameters.
- CONTINUATION - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
D
- demand() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Explicitly demands for WebSocket events.
- disconnect() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Abruptly closes the WebSocket connection without sending a CLOSE frame.
E
- ExtensionConfig - Interface in org.eclipse.jetty.websocket.api
-
Represents an Extension Configuration, as seen during the connection Handshake process.
- ExtensionConfig.Parser - Interface in org.eclipse.jetty.websocket.api
F
- fail(Throwable) - Method in class org.eclipse.jetty.websocket.api.Callback.Completable
- fail(Throwable) - Method in interface org.eclipse.jetty.websocket.api.Callback
-
Method to invoke to fail the callback.
- FAILED_TLS_HANDSHAKE - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- Frame - Interface in org.eclipse.jetty.websocket.api
-
An immutable websocket frame.
- Frame.Type - Enum Class in org.eclipse.jetty.websocket.api
- from(byte) - Static method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- from(Runnable, Consumer<Throwable>) - Static method in interface org.eclipse.jetty.websocket.api.Callback
-
Creates a callback from the given success and failure lambdas.
G
- getAcceptedSubProtocol() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the accepted WebSocket protocol.
- getCookies() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the list of Cookies on the Upgrade request
- getExecutor() - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
The Container provided Executor.
- getExtensions() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the list of WebSocket Extension Configurations for this Upgrade Request.
- getExtensions() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the list of extensions that should be used for the websocket.
- getHeader(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get a specific Header value from Upgrade Request
- getHeader(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get a header value
- getHeaderInt(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the specific Header value, as an
int
, from the Upgrade Request. - getHeaderNames() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the header names
- getHeaders() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the headers as a Map of keys to value lists.
- getHeaders() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the headers map
- getHeaders(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the specific header values (for multi-value headers)
- getHeaders(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the multi-value header value
- getHost() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
The host of the Upgrade Request URI
- getHttpVersion() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
The HTTP version used for this Upgrade Request
- getIdleTimeout() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The duration that a websocket may be idle before being closed by the implementation
- getInputBufferSize() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The input (read from network layer) buffer size.
- getLocalSocketAddress() - Method in interface org.eclipse.jetty.websocket.api.Session
- getMask() - Method in interface org.eclipse.jetty.websocket.api.Frame
- getMaxBinaryMessageSize() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
Get the maximum size of a binary message during parsing.
- getMaxFrameSize() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The maximum payload size of any WebSocket Frame which can be received.
- getMaxOutgoingFrames() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
Get the maximum number of data frames allowed to be waiting to be sent at any one time.
- getMaxTextMessageSize() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
Get the maximum size of a text message during parsing.
- getMethod() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
The HTTP method for this Upgrade Request.
- getName() - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- getOpCode() - Method in interface org.eclipse.jetty.websocket.api.Frame
- getOpCode() - Method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- getOpenSessions() - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
Get the collection of open Sessions being tracked by this container
- getOrigin() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
The WebSocket Origin of this Upgrade Request
- getOutputBufferSize() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The output (write to network layer) buffer size.
- getParameter(String, int) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- getParameter(String, String) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- getParameterizedName() - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- getParameterKeys() - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- getParameterMap() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Returns a map of the query parameters of the request.
- getParameters() - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
-
Return parameters found in request URI.
- getPayload() - Method in interface org.eclipse.jetty.websocket.api.Frame
- getPayloadLength() - Method in interface org.eclipse.jetty.websocket.api.Frame
-
The original payload length (
Buffer.remaining()
) - getProtocolVersion() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Returns the version of the WebSocket protocol currently being used.
- getProtocolVersion() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the WebSocket Protocol Version
- getQueryString() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the Query String of the request URI.
- getRemoteSocketAddress() - Method in interface org.eclipse.jetty.websocket.api.Session
- getRequestURI() - Method in exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- getRequestURI() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the Request URI
- getResponseStatusCode() - Method in exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- getSession() - Method in class org.eclipse.jetty.websocket.api.Session.Listener.Abstract
- getStatusCode() - Method in exception class org.eclipse.jetty.websocket.api.exceptions.CloseException
- getStatusCode() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the HTTP Response Status Code
- getSubProtocols() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the list of offered WebSocket sub-protocols.
- getType() - Method in interface org.eclipse.jetty.websocket.api.Frame
- getUpgradeRequest() - Method in interface org.eclipse.jetty.websocket.api.Session
- getUpgradeResponse() - Method in interface org.eclipse.jetty.websocket.api.Session
- getUserPrincipal() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Get the User Principal for this request.
H
- hasPayload() - Method in interface org.eclipse.jetty.websocket.api.Frame
- hasSubProtocol(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Test if a specific sub-protocol is offered
I
- INVALID_UPSTREAM_RESPONSE - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1014 indicates that a gateway or proxy received and invalid upstream response.
- InvalidWebSocketException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Indicating that the provided Class is not a valid WebSocket as defined by the API.
- InvalidWebSocketException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException
- InvalidWebSocketException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException
- isAutoFragment() - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
If true, frames are automatically fragmented to respect the maximum frame size.
- isContinuation() - Method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- isControl() - Method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- isData() - Method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- isFin() - Method in interface org.eclipse.jetty.websocket.api.Frame
- isMasked() - Method in interface org.eclipse.jetty.websocket.api.Frame
- isOpen() - Method in interface org.eclipse.jetty.websocket.api.Session
- isOpen() - Method in class org.eclipse.jetty.websocket.api.Session.Listener.Abstract
- isRsv1() - Method in interface org.eclipse.jetty.websocket.api.Frame
- isRsv2() - Method in interface org.eclipse.jetty.websocket.api.Frame
- isRsv3() - Method in interface org.eclipse.jetty.websocket.api.Frame
- isSecure() - Method in interface org.eclipse.jetty.websocket.api.Session
- isSecure() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest
-
Test if connection is secure.
- isTransmittable(int) - Static method in class org.eclipse.jetty.websocket.api.StatusCode
-
Test if provided status code can be sent/received on a WebSocket close.
M
- MESSAGE_TOO_LARGE - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
- MessageTooLargeException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Exception when a message is too large for the internal buffers occurs and should trigger a connection close.
- MessageTooLargeException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException
- MessageTooLargeException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException
- MessageTooLargeException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException
N
- NO_CLOSE - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NO_CODE - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NOOP - Static variable in interface org.eclipse.jetty.websocket.api.Callback
-
Empty implementation.
- NORMAL - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
- notifySessionListeners(Consumer<WebSocketSessionListener>) - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
Notify the Session Listeners of an event.
O
- onWebSocketBinary(ByteBuffer, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket BINARY message has been received.
- onWebSocketClose(int, String) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
The WebSocket
Session
has been closed. - OnWebSocketClose - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for methods to receive WebSocket close events.
- onWebSocketError(Throwable) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket error has occurred during the processing of WebSocket frames.
- OnWebSocketError - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for methods to receive WebSocket errors.
- onWebSocketFrame(Frame, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket frame has been received.
- OnWebSocketFrame - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for methods to receive WebSocket frame events.
- OnWebSocketMessage - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for methods to receive BINARY or TEXT WebSocket events.
- onWebSocketOpen(Session) - Method in class org.eclipse.jetty.websocket.api.Session.Listener.Abstract
- onWebSocketOpen(Session) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket
Session
has opened successfully and is ready to be used. - OnWebSocketOpen - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for methods to receive WebSocket connect events.
- onWebSocketPartialBinary(ByteBuffer, boolean, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket BINARY (or associated CONTINUATION) frame has been received.
- onWebSocketPartialText(String, boolean) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket TEXT (or associated CONTINUATION) frame has been received.
- onWebSocketPing(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket PING frame has been received.
- onWebSocketPong(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket PONG frame has been received.
- onWebSocketSessionClosed(Session) - Method in interface org.eclipse.jetty.websocket.api.WebSocketSessionListener
- onWebSocketSessionCreated(Session) - Method in interface org.eclipse.jetty.websocket.api.WebSocketSessionListener
- onWebSocketSessionOpened(Session) - Method in interface org.eclipse.jetty.websocket.api.WebSocketSessionListener
- onWebSocketText(String) - Method in interface org.eclipse.jetty.websocket.api.Session.Listener
-
A WebSocket TEXT message has been received.
- org.eclipse.jetty.websocket.api - module org.eclipse.jetty.websocket.api
- org.eclipse.jetty.websocket.api - package org.eclipse.jetty.websocket.api
- org.eclipse.jetty.websocket.api.annotations - package org.eclipse.jetty.websocket.api.annotations
- org.eclipse.jetty.websocket.api.exceptions - package org.eclipse.jetty.websocket.api.exceptions
- org.eclipse.jetty.websocket.api.util - package org.eclipse.jetty.websocket.api.util
-
Jetty WebSocket API : Utility Classes
P
- parse(String) - Static method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- parse(String) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig.Parser
- PING - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
- POLICY_VIOLATION - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
- PolicyViolationException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Exception when a violation of policy occurs and should trigger a connection close.
- PolicyViolationException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PolicyViolationException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PolicyViolationException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PONG - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
- PROTOCOL - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1002 indicates that an endpoint is terminating the connection due to a protocol error.
- ProtocolException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)
- ProtocolException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.ProtocolException
- ProtocolException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.ProtocolException
- ProtocolException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.ProtocolException
R
- removeSessionListener(WebSocketSessionListener) - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
Remove a WebSocketSessionListener from the container
- REQUIRED_EXTENSION - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
S
- SEC_WEBSOCKET_ACCEPT - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- SEC_WEBSOCKET_EXTENSIONS - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- SEC_WEBSOCKET_KEY - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- SEC_WEBSOCKET_ORIGIN - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- SEC_WEBSOCKET_PROTOCOL - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- SEC_WEBSOCKET_VERSION - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- sendBinary(ByteBuffer, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a BINARY message, notifying the given callback when the message send is completed, either successfully or with a failure.
- sendPartialBinary(ByteBuffer, boolean, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a BINARY frame, possibly part of a larger binary message, notifying the given callback when the frame send is completed, either successfully or with a failure.
- sendPartialText(String, boolean, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a TEXT frame, possibly part of a larger binary message, notifying the given callback when the frame send is completed, either successfully or with a failure.
- sendPing(ByteBuffer, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a PING frame, notifying the given callback when the frame send is completed, either successfully or with a failure.
- sendPong(ByteBuffer, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a PONG frame, notifying the given callback when the frame send is completed, either successfully or with a failure.
- sendText(String, Callback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Initiates the asynchronous send of a TEXT message, notifying the given callback when the message send is completed, either successfully or with a failure.
- SERVER_ERROR - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
- SERVICE_RESTART - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1012 indicates that the service is restarted.
- Session - Interface in org.eclipse.jetty.websocket.api
-
Session
represents an active link of communication with a remote WebSocket endpoint. - Session.Listener - Interface in org.eclipse.jetty.websocket.api
-
The passive link of communication with a remote WebSocket endpoint.
- Session.Listener.Abstract - Class in org.eclipse.jetty.websocket.api
- Session.Listener.AbstractAutoDemanding - Class in org.eclipse.jetty.websocket.api
- Session.Listener.AutoDemanding - Interface in org.eclipse.jetty.websocket.api
-
Tag interface that signals that the WebSocket endpoint is demanding for WebSocket frames automatically.
- setAutoFragment(boolean) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
If set to true, frames are automatically fragmented to respect the maximum frame size.
- setIdleTimeout(Duration) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The duration that a websocket may be idle before being closed by the implementation
- setInputBufferSize(int) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The input (read from network layer) buffer size.
- setMaxBinaryMessageSize(long) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The maximum size of a binary message during parsing/generating.
- setMaxFrameSize(long) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The maximum payload size of any WebSocket Frame which can be received.
- setMaxOutgoingFrames(int) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
Set the maximum number of data frames allowed to be waiting to be sent at any one time.
- setMaxTextMessageSize(long) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The maximum size of a text message during parsing/generating.
- setOutputBufferSize(int) - Method in interface org.eclipse.jetty.websocket.api.Configurable
-
The output (write to network layer) buffer size.
- setParameter(String) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- setParameter(String, int) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- setParameter(String, String) - Method in interface org.eclipse.jetty.websocket.api.ExtensionConfig
- SHUTDOWN - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
- SPEC_VERSION - Static variable in class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- StatusCode - Class in org.eclipse.jetty.websocket.api
- StatusCode() - Constructor for class org.eclipse.jetty.websocket.api.StatusCode
- succeed() - Method in class org.eclipse.jetty.websocket.api.Callback.Completable
- succeed() - Method in interface org.eclipse.jetty.websocket.api.Callback
-
Method to invoke to succeed the callback.
T
- TEXT - Enum constant in enum class org.eclipse.jetty.websocket.api.Frame.Type
- toHttp(URI) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI
-
Convert to HTTP
http
orhttps
scheme URIs. - toString() - Method in enum class org.eclipse.jetty.websocket.api.Frame.Type
- toWebsocket(CharSequence) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI
-
Convert to WebSocket
ws
orwss
scheme URIs - toWebsocket(CharSequence, String) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI
-
Convert to WebSocket
ws
orwss
scheme URIs - toWebsocket(URI) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI
-
Convert to WebSocket
ws
orwss
scheme URIs - TRY_AGAIN_LATER - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
1013 indicates that the service is experiencing overload.
U
- UNDEFINED - Static variable in class org.eclipse.jetty.websocket.api.StatusCode
-
Reserved.
- UpgradeException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Exception during WebSocket Upgrade Handshake.
- UpgradeException(URI, int, String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, int, String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, int, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeRequest - Interface in org.eclipse.jetty.websocket.api
-
The HTTP Upgrade to WebSocket Request
- UpgradeResponse - Interface in org.eclipse.jetty.websocket.api
-
The HTTP Upgrade to WebSocket Response
V
- valueOf(String) - Static method in enum class org.eclipse.jetty.websocket.api.Frame.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.eclipse.jetty.websocket.api.Frame.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WebSocket - Annotation Interface in org.eclipse.jetty.websocket.api.annotations
-
Annotation for classes to be WebSocket endpoints.
- WebSocketConstants - Class in org.eclipse.jetty.websocket.api.util
- WebSocketConstants() - Constructor for class org.eclipse.jetty.websocket.api.util.WebSocketConstants
- WebSocketContainer - Interface in org.eclipse.jetty.websocket.api
-
Generic interface to the Container (server or client)
- WebSocketException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
A recoverable exception within the websocket framework.
- WebSocketException() - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketSessionListener - Interface in org.eclipse.jetty.websocket.api
-
Interface for Listeners that are interested in knowing about the Session history.
- WebSocketTimeoutException - Exception Class in org.eclipse.jetty.websocket.api.exceptions
-
Exception thrown to indicate a connection I/O timeout.
- WebSocketTimeoutException(String) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- WebSocketTimeoutException(String, Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- WebSocketTimeoutException(Throwable) - Constructor for exception class org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- with(Consumer<Callback.Completable>) - Static method in class org.eclipse.jetty.websocket.api.Callback.Completable
-
Convenience method that creates a
Callback.Completable
that is passed to the given consumer and then returned. - WSURI - Class in org.eclipse.jetty.websocket.api.util
-
Utility methods for converting a
URI
between a HTTP(S) and WS(S) URI. - WSURI() - Constructor for class org.eclipse.jetty.websocket.api.util.WSURI
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form