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. - Adaptor() - Constructor for class org.eclipse.jetty.websocket.api.WriteCallback.Adaptor
-
Deprecated.
- addSessionListener(WebSocketSessionListener) - Method in interface org.eclipse.jetty.websocket.api.WebSocketContainer
-
Register a WebSocketSessionListener with the container
- AUTO - Enum constant in enum org.eclipse.jetty.websocket.api.BatchMode
-
Implementers are free to decide whether to send or not frames to the network layer.
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 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 org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- BadPayloadException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- BadPayloadException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.BadPayloadException
- batchMode() - Element in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
-
The output frame buffering mode.
- BatchMode - Enum in org.eclipse.jetty.websocket.api
-
The possible batch modes when enqueuing outgoing frames.
- BINARY - Enum constant in enum org.eclipse.jetty.websocket.api.Frame.Type
C
- CLIENT - Enum constant in enum org.eclipse.jetty.websocket.api.WebSocketBehavior
- close() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Request a close of the current conversation with a normal status code and no reason phrase.
- close(int, String) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Send a websocket Close frame, with status code.
- close(int, String, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Send a websocket Close frame, with status code.
- close(CloseStatus) - Method in interface org.eclipse.jetty.websocket.api.Session
-
Request Close the current conversation, giving a reason for the closure.
- CLOSE - Enum constant in enum org.eclipse.jetty.websocket.api.Frame.Type
- CloseException - Exception in org.eclipse.jetty.websocket.api.exceptions
- CloseException(int, String) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.CloseException
- CloseException(int, String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.CloseException
- CloseException(int, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.CloseException
- CloseStatus - Class in org.eclipse.jetty.websocket.api
- CloseStatus(int, String) - Constructor for class org.eclipse.jetty.websocket.api.CloseStatus
-
Creates a reason for closing a web socket connection with the given code and reason phrase.
- CONTINUATION - Enum constant in enum org.eclipse.jetty.websocket.api.Frame.Type
D
- disconnect() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Issue a harsh disconnect of the underlying connection.
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
- 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.
- flush() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Flushes messages that may have been batched by the implementation.
- Frame - Interface in org.eclipse.jetty.websocket.api
-
An immutable websocket frame.
- Frame.Type - Enum in org.eclipse.jetty.websocket.api
- from(byte) - Static method in enum org.eclipse.jetty.websocket.api.Frame.Type
G
- getAcceptedSubProtocol() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse
-
Get the accepted WebSocket protocol.
- getBatchMode() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
- getBehavior() - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
- getCode() - Method in class org.eclipse.jetty.websocket.api.CloseStatus
- 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.WebSocketPolicy
-
The duration that a websocket may be idle before being closed by the implementation
- getInputBufferSize() - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The input (read from network layer) buffer size.
- getLocalAddress() - Method in interface org.eclipse.jetty.websocket.api.Session
-
The Local Socket Address for the active Session
- getMask() - Method in interface org.eclipse.jetty.websocket.api.Frame
- getMaxBinaryMessageSize() - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
Get the maximum size of a binary message during parsing.
- getMaxFrameSize() - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The maximum payload size of any WebSocket Frame which can be received.
- getMaxOutgoingFrames() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
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.WebSocketPolicy
-
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 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.WebSocketPolicy
-
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()
) - getPhrase() - Method in class org.eclipse.jetty.websocket.api.CloseStatus
- getPolicy() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Access the (now read-only)
WebSocketPolicy
in use for this connection. - 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.
- getRemote() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Return a reference to the RemoteEndpoint object representing the other end of this conversation.
- getRemote() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- getRemoteAddress() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Get the SocketAddress for the established connection.
- getRemoteAddress() - Method in interface org.eclipse.jetty.websocket.api.Session
-
The Remote Socket Address for the active Session
- getRequestURI() - Method in exception 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 org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- getSession() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- getStatusCode() - Method in exception 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
-
Get the UpgradeRequest used to create this session
- getUpgradeResponse() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Get the UpgradeResponse used to create this 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
- idleTimeout() - Element in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
-
The time in ms (milliseconds) that a websocket may be idle before closing.
- inputBufferSize() - Element in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
-
The size of the buffer (in bytes) used to read from the network layer.
- 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 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 org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException
- InvalidWebSocketException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException
- isAutoFragment() - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
If true, frames are automatically fragmented to respect the maximum frame size.
- isConnected() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- isContinuation() - Method in enum org.eclipse.jetty.websocket.api.Frame.Type
- isControl() - Method in enum org.eclipse.jetty.websocket.api.Frame.Type
- isData() - Method in enum 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
- isNotConnected() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- isOpen() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Return true if and only if the underlying socket is open.
- 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
-
Return true if and only if the underlying socket is using a secure transport.
- 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
- max(BatchMode, BatchMode) - Static method in enum org.eclipse.jetty.websocket.api.BatchMode
- MAX_REASON_PHRASE - Static variable in class org.eclipse.jetty.websocket.api.CloseStatus
- maxBinaryMessageSize() - Element in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
-
The maximum size of a binary message (in bytes) during parsing/generating.
- maxTextMessageSize() - Element in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
-
The maximum size of a text message during parsing/generating.
- 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 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 org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException
- MessageTooLargeException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException
- MessageTooLargeException(Throwable) - Constructor for exception 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.WriteCallback
- 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
- OFF - Enum constant in enum org.eclipse.jetty.websocket.api.BatchMode
-
Implementers must send frames to the network layer.
- ON - Enum constant in enum org.eclipse.jetty.websocket.api.BatchMode
-
Implementers must batch frames.
- onWebSocketBinary(byte[], int, int) - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- onWebSocketBinary(byte[], int, int) - Method in interface org.eclipse.jetty.websocket.api.WebSocketListener
-
A WebSocket binary frame has been received.
- onWebSocketClose(int, String) - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- onWebSocketClose(int, String) - Method in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener
-
A Close Event was received.
- OnWebSocketClose - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
Annotation for tagging methods to receive connection close events.
- onWebSocketConnect(Session) - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- onWebSocketConnect(Session) - Method in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener
-
A WebSocket
Session
has connected successfully and is ready to be used. - OnWebSocketConnect - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
Annotation for tagging methods to receive connection open events.
- onWebSocketError(Throwable) - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
- onWebSocketError(Throwable) - Method in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener
-
A WebSocket exception has occurred.
- OnWebSocketError - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
Annotation for receiving websocket errors (exceptions) that have occurred internally in the websocket implementation.
- onWebSocketFrame(Frame) - Method in interface org.eclipse.jetty.websocket.api.WebSocketFrameListener
-
A WebSocket frame has been received.
- OnWebSocketFrame - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
(ADVANCED) Annotation for tagging methods to receive frame events.
- OnWebSocketMessage - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
Annotation for tagging methods to receive Binary or Text Message events.
- onWebSocketPartialBinary(ByteBuffer, boolean) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPartialListener
-
A WebSocket BINARY (or associated CONTINUATION) frame has been received.
- onWebSocketPartialText(String, boolean) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPartialListener
-
A WebSocket TEXT (or associated CONTINUATION) frame has been received.
- onWebSocketPing(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPingPongListener
-
A WebSocket PING has been received.
- onWebSocketPong(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPingPongListener
-
A WebSocket PONG 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 class org.eclipse.jetty.websocket.api.WebSocketAdapter
- onWebSocketText(String) - Method in interface org.eclipse.jetty.websocket.api.WebSocketListener
-
A WebSocket Text frame was received.
- org.eclipse.jetty.websocket.api - package org.eclipse.jetty.websocket.api
-
Jetty WebSocket API
- org.eclipse.jetty.websocket.api.annotations - package org.eclipse.jetty.websocket.api.annotations
-
Jetty WebSocket API : WebSocket POJO Annotations
- org.eclipse.jetty.websocket.api.exceptions - package org.eclipse.jetty.websocket.api.exceptions
-
Jetty WebSocket API : Exception Types
- org.eclipse.jetty.websocket.api.util - package org.eclipse.jetty.websocket.api.util
-
Jetty WebSocket API : Utility Classes
- org.eclipse.jetty.websocket.jetty.api - module org.eclipse.jetty.websocket.jetty.api
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 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 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 org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PolicyViolationException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PolicyViolationException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.PolicyViolationException
- PONG - Enum constant in enum 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 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 org.eclipse.jetty.websocket.api.exceptions.ProtocolException
- ProtocolException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.ProtocolException
- ProtocolException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.ProtocolException
R
- RemoteEndpoint - Interface in org.eclipse.jetty.websocket.api
- 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.
- resume() - Method in interface org.eclipse.jetty.websocket.api.SuspendToken
-
Resume a previously suspended connection.
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
- sendBytes(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Send a binary message, returning when all bytes of the message has been transmitted.
- sendBytes(ByteBuffer, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Initiates the asynchronous transmission of a binary message.
- sendPartialBytes(ByteBuffer, boolean) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Send a binary message in pieces, blocking until all of the message has been transmitted.
- sendPartialBytes(ByteBuffer, boolean, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Initiates the asynchronous transmission of a partial binary message.
- sendPartialString(String, boolean) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Send a text message in pieces, blocking until all of the message has been transmitted.
- sendPartialString(String, boolean, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Initiates the asynchronous transmission of a partial text message.
- sendPing(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Send a Ping message containing the given application data to the remote endpoint, blocking until all of the message has been transmitted.
- sendPing(ByteBuffer, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Asynchronously send a Ping message containing the given application data to the remote endpoint.
- sendPong(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session, this will block until all of the message has been transmitted.
- sendPong(ByteBuffer, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Allows the developer to asynchronously send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session.
- sendString(String) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Send a text message, blocking until all bytes of the message has been transmitted.
- sendString(String, WriteCallback) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Initiates the asynchronous transmission of a text message.
- SERVER - Enum constant in enum org.eclipse.jetty.websocket.api.WebSocketBehavior
- 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 communications with a Remote WebSocket Endpoint.
- setAutoFragment(boolean) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
If set to true, frames are automatically fragmented to respect the maximum frame size.
- setBatchMode(BatchMode) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
Set the batch mode with which messages are sent.
- setIdleTimeout(Duration) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The duration that a websocket may be idle before being closed by the implementation
- setInputBufferSize(int) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The input (read from network layer) buffer size.
- setMaxBinaryMessageSize(long) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The maximum size of a binary message during parsing/generating.
- setMaxFrameSize(long) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
The maximum payload size of any WebSocket Frame which can be received.
- setMaxOutgoingFrames(int) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
-
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.WebSocketPolicy
-
The maximum size of a text message during parsing/generating.
- setOutputBufferSize(int) - Method in interface org.eclipse.jetty.websocket.api.WebSocketPolicy
-
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
- suspend() - Method in interface org.eclipse.jetty.websocket.api.Session
-
Suspend the delivery of incoming WebSocket frames.
- SuspendToken - Interface in org.eclipse.jetty.websocket.api
-
Connection suspend token
T
- TEXT - Enum constant in enum 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 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 in org.eclipse.jetty.websocket.api.exceptions
-
Exception during WebSocket Upgrade Handshake.
- UpgradeException(URI, int, String) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, int, String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, int, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.UpgradeException
- UpgradeException(URI, Throwable) - Constructor for exception 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 org.eclipse.jetty.websocket.api.BatchMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.eclipse.jetty.websocket.api.Frame.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.eclipse.jetty.websocket.api.WebSocketBehavior
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.eclipse.jetty.websocket.api.BatchMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.eclipse.jetty.websocket.api.Frame.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.eclipse.jetty.websocket.api.WebSocketBehavior
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WebSocket - Annotation Type in org.eclipse.jetty.websocket.api.annotations
-
Tags a POJO as being a WebSocket class.
- WebSocketAdapter - Class in org.eclipse.jetty.websocket.api
-
Default implementation of the
WebSocketListener
. - WebSocketAdapter() - Constructor for class org.eclipse.jetty.websocket.api.WebSocketAdapter
- WebSocketBehavior - Enum in org.eclipse.jetty.websocket.api
-
Behavior for how the WebSocket should operate.
- WebSocketConnectionListener - Interface in org.eclipse.jetty.websocket.api
-
Core WebSocket Connection Listener
- 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 in org.eclipse.jetty.websocket.api.exceptions
-
A recoverable exception within the websocket framework.
- WebSocketException() - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(String) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketException
- WebSocketFrameListener - Interface in org.eclipse.jetty.websocket.api
-
WebSocket Frame Listener interface for incoming WebSocket frames.
- WebSocketListener - Interface in org.eclipse.jetty.websocket.api
-
Basic WebSocket Listener interface for incoming WebSocket message events.
- WebSocketPartialListener - Interface in org.eclipse.jetty.websocket.api
-
WebSocket Partial Message Listener interface for incoming WebSocket TEXT/BINARY/CONTINUATION frames.
- WebSocketPingPongListener - Interface in org.eclipse.jetty.websocket.api
-
WebSocket PING/PONG Listener interface for incoming WebSocket PING/PONG frames.
- WebSocketPolicy - Interface in org.eclipse.jetty.websocket.api
-
Settings for WebSocket operations.
- WebSocketSessionListener - Interface in org.eclipse.jetty.websocket.api
-
Interface for Listeners that are interested in knowing about the Session history.
- WebSocketTimeoutException - Exception in org.eclipse.jetty.websocket.api.exceptions
-
Exception thrown to indicate a connection I/O timeout.
- WebSocketTimeoutException(String) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- WebSocketTimeoutException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- WebSocketTimeoutException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException
- WriteCallback - Interface in org.eclipse.jetty.websocket.api
-
Callback for Write events.
- WriteCallback.Adaptor - Class in org.eclipse.jetty.websocket.api
-
Deprecated.
- writeFailed(Throwable) - Method in class org.eclipse.jetty.websocket.api.WriteCallback.Adaptor
-
Deprecated.
- writeFailed(Throwable) - Method in interface org.eclipse.jetty.websocket.api.WriteCallback
-
Callback invoked when the write fails.
- writeSuccess() - Method in class org.eclipse.jetty.websocket.api.WriteCallback.Adaptor
-
Deprecated.
- writeSuccess() - Method in interface org.eclipse.jetty.websocket.api.WriteCallback
-
Callback invoked when the write succeeds.
- 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