Index (Jetty :: Websocket :: API 9.4.30.v20200611 API)

A B C D E F G H I J M N O P Q R S T U V W
All Classes All Packages

A

ABNF_REQUIRED_QUOTING - Static variable in class org.eclipse.jetty.websocket.api.util.QuoteUtil: ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.
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.
addExtensions(String...) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Add WebSocket Extension Configuration(s) to request
addExtensions(ExtensionConfig...) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Add WebSocket Extension Configuration(s) to Upgrade Request.
addHeader(String, String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Add a header value to the response.
assertValidBinaryMessageSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
assertValidTextMessageSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
AUTO - 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: 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.BadPayloadException
BadPayloadException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.BadPayloadException
BadPayloadException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.BadPayloadException
batchMode() - Method in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
BatchMode - Enum in org.eclipse.jetty.websocket.api: The possible batch modes when invoking OutgoingFrames.outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame, WriteCallback, BatchMode).
BINARY - org.eclipse.jetty.websocket.api.extensions.Frame.Type

C

clearHeaders() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Deprecated.
(no longer supported, as this can undo the required upgrade request headers)
CLIENT - org.eclipse.jetty.websocket.api.WebSocketBehavior
clonePolicy() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Make a copy of the policy, with current values.
clonePolicy(WebSocketBehavior) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Deprecated.
use WebSocketPolicy.delegateAs(WebSocketBehavior) instead
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(CloseStatus) - Method in interface org.eclipse.jetty.websocket.api.Session: Request Close the current conversation, giving a reason for the closure.
CLOSE - org.eclipse.jetty.websocket.api.extensions.Frame.Type
CloseException - Exception in org.eclipse.jetty.websocket.api
CloseException(int, String) - Constructor for exception org.eclipse.jetty.websocket.api.CloseException
CloseException(int, String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.CloseException
CloseException(int, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.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 - org.eclipse.jetty.websocket.api.extensions.Frame.Type

D

delegateAs(WebSocketBehavior) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
dequote(String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil: Remove quotes from a string, only if the input string start with and end with the same quote character.
disconnect() - Method in interface org.eclipse.jetty.websocket.api.Session: Issue a harsh disconnect of the underlying connection.

E

escape(StringBuilder, String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil
Extension - Interface in org.eclipse.jetty.websocket.api.extensions: Interface for WebSocket Extensions.
ExtensionConfig - Class in org.eclipse.jetty.websocket.api.extensions: Represents an Extension Configuration, as seen during the connection Handshake process.
ExtensionConfig(String) - Constructor for class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
ExtensionConfig(ExtensionConfig) - Constructor for class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Copy constructor
ExtensionFactory - Class in org.eclipse.jetty.websocket.api.extensions: Deprecated.
this class is removed from Jetty 10.0.0+
ExtensionFactory() - Constructor for class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.

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.extensions: An immutable websocket frame.
Frame.Type - Enum in org.eclipse.jetty.websocket.api.extensions
from(byte) - Static method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type

G

getAcceptedSubProtocol() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Get the accepted WebSocket protocol.
getAsyncWriteTimeout() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Deprecated.
getAvailableExtensions() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
getBatchMode() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint
getBehavior() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
getCode() - Method in class org.eclipse.jetty.websocket.api.CloseStatus
getConfig() - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: The active configuration for this extension.
getCookies() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Get the list of Cookies on the Upgrade request
getExtension(String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
getExtensionNames() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
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.Session: Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received in that time.
getIdleTimeout() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The time in ms (milliseconds) that a websocket connection may be idle before being closed automatically.
getInetSocketAddress() - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint: Get the InetSocketAddress for the established connection.
getInputBufferSize() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The size of the input (read from network layer) buffer size.
getLocalAddress() - Method in interface org.eclipse.jetty.websocket.api.Session: Get the address of the local side.
getMask() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
getMaxBinaryMessageBufferSize() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Get the maximum size of a binary message buffer (for streaming writing)
getMaxBinaryMessageSize() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Get the maximum size of a binary message during parsing.
getMaxTextMessageBufferSize() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: Get the maximum size of a text message buffer (for streaming writing)
getMaxTextMessageSize() - Method in class 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.extensions.Extension: The Sec-WebSocket-Extensions name for this extension.
getName() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
getOpCode() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
getOpCode() - Method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type
getOrigin() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: The WebSocket Origin of this Upgrade Request
getParameter(String, int) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
getParameter(String, String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
getParameterizedName() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
getParameterKeys() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
getParameterMap() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Returns a map of the query parameters of the request.
getParameters() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Return parameters found in request URI.
getPayload() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
getPayloadLength() - Method in interface org.eclipse.jetty.websocket.api.extensions.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.Session: Get the address of the remote side.
getRequestURI() - Method in exception org.eclipse.jetty.websocket.api.UpgradeException
getRequestURI() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Get the Request URI
getResponseStatusCode() - Method in exception org.eclipse.jetty.websocket.api.UpgradeException
getSession() - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Access the Servlet HTTP Session (if present)
getSession() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
getStatusCode() - Method in exception org.eclipse.jetty.websocket.api.CloseException
getStatusCode() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Get the HTTP Response Status Code
getStatusReason() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Get the HTTP Response Status Reason
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.extensions.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.extensions.Frame
hasSubProtocol(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Test if a specific sub-protocol is offered

I

incomingFrame(Frame) - Method in interface org.eclipse.jetty.websocket.api.extensions.IncomingFrames: Process the incoming frame.
IncomingFrames - Interface in org.eclipse.jetty.websocket.api.extensions: Interface for dealing with Incoming Frames.
init(ExtensionConfig) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Initialize the parameters on this config from the other configuration.
inputBufferSize() - Method in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
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: 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.InvalidWebSocketException
InvalidWebSocketException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.InvalidWebSocketException
isAvailable(String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
isConnected() - Method in class org.eclipse.jetty.websocket.api.WebSocketAdapter
isContinuation() - Method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type
isControl() - Method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type
isData() - Method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type
isFatal(int) - Static method in class org.eclipse.jetty.websocket.api.StatusCode: Test if provided status code is a fatal failure for bad protocol behavior.
isFin() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
isLast() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame: Deprecated.
use Frame.isFin() instead
isMasked() - Method in interface org.eclipse.jetty.websocket.api.extensions.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.
isOrigin(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Test if supplied Origin is the same as the Request
isRsv1() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
isRsv1User() - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
isRsv2() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
isRsv2User() - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.
isRsv3() - Method in interface org.eclipse.jetty.websocket.api.extensions.Frame
isRsv3User() - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
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.
isSuccess() - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Deprecated.
this has no replacement, will be removed in Jetty 10
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.
iterator() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.

J

join(Object[], String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil
join(Collection<?>, String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil

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() - Method in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
maxIdleTime() - Method in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
maxTextMessageSize() - Method in annotation type org.eclipse.jetty.websocket.api.annotations.WebSocket
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: 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.MessageTooLargeException
MessageTooLargeException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.MessageTooLargeException
MessageTooLargeException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.MessageTooLargeException

N

newClientPolicy() - Static method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
newInstance(ExtensionConfig) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
newServerPolicy() - Static method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
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.
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.

O

OFF - org.eclipse.jetty.websocket.api.BatchMode: Implementers must send frames to the network layer.
ON - 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.
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.extensions - package org.eclipse.jetty.websocket.api.extensions: Jetty WebSocket API : WebSocket Extension API
org.eclipse.jetty.websocket.api.util - package org.eclipse.jetty.websocket.api.util: Jetty WebSocket API : Utility Classes
outgoingFrame(Frame, WriteCallback, BatchMode) - Method in interface org.eclipse.jetty.websocket.api.extensions.OutgoingFrames: A frame, and optional callback, intended for the network layer.
OutgoingFrames - Interface in org.eclipse.jetty.websocket.api.extensions: Interface for dealing with frames outgoing to (eventually) the network layer.

P

parse(String) - Static method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Parse a single parameterized name.
parseEnum(Enumeration<String>) - Static method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Parse enumeration of Sec-WebSocket-Extensions header values into a ExtensionConfig list
parseList(String...) - Static method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Parse 1 or more raw Sec-WebSocket-Extensions header values into a ExtensionConfig list
PING - org.eclipse.jetty.websocket.api.extensions.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: Exception when a violation of policy occurs and should trigger a connection close.
PolicyViolationException(String) - Constructor for exception org.eclipse.jetty.websocket.api.PolicyViolationException
PolicyViolationException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.PolicyViolationException
PolicyViolationException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.PolicyViolationException
PONG - org.eclipse.jetty.websocket.api.extensions.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: 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.ProtocolException
ProtocolException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.ProtocolException
ProtocolException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.ProtocolException

Q

quote(StringBuilder, String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil: Simple quote of a string, escaping where needed.
quoteIfNeeded(StringBuilder, String, String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil: Append into buf the provided string, adding quotes if needed.
QuoteUtil - Class in org.eclipse.jetty.websocket.api.util: Provide some consistent Http header value and Extension configuration parameter quoting support.
QuoteUtil() - Constructor for class org.eclipse.jetty.websocket.api.util.QuoteUtil

R

register(String, Class<? extends Extension>) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
RemoteEndpoint - Interface in org.eclipse.jetty.websocket.api
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_EXTENSIONS - Static variable in class org.eclipse.jetty.websocket.api.WebSocketConstants
SEC_WEBSOCKET_PROTOCOL - Static variable in class org.eclipse.jetty.websocket.api.WebSocketConstants
SEC_WEBSOCKET_VERSION - Static variable in class org.eclipse.jetty.websocket.api.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.
sendBytesByFuture(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint: Initiates the asynchronous transmission of a binary message.
sendForbidden(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Issue a forbidden upgrade response.
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.
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.
sendPing(ByteBuffer) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint: 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.
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.
sendStringByFuture(String) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint: Initiates the asynchronous transmission of a text message.
SERVER - 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.
setAcceptedSubProtocol(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Set the accepted WebSocket Protocol.
setAsyncWriteTimeout(long) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The timeout in ms (milliseconds) for async write operations.
setBatchMode(BatchMode) - Method in interface org.eclipse.jetty.websocket.api.RemoteEndpoint: Set the batch mode with which messages are sent.
setCookies(List<HttpCookie>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the list of Cookies on the request
setExtensions(List<ExtensionConfig>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the list of WebSocket Extension configurations on the request.
setExtensions(List<ExtensionConfig>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Set the list of extensions that are approved for use with this websocket.
setHeader(String, String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set a specific header value
setHeader(String, String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Set a header
setHeader(String, List<String>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set a specific header with multi-value field
setHeaders(Map<String, List<String>>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Sets multiple headers on the request.
setHttpVersion(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the HTTP Version to use.
setIdleTimeout(long) - Method in interface org.eclipse.jetty.websocket.api.Session: Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.
setIdleTimeout(long) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The time in ms (milliseconds) that a websocket may be idle before closing.
setInputBufferSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The size of the input (read from network layer) buffer size.
setMaxBinaryMessageBufferSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The maximum size of a binary message buffer.
setMaxBinaryMessageSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The maximum size of a binary message during parsing.
setMaxTextMessageBufferSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The maximum size of a text message buffer.
setMaxTextMessageSize(int) - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy: The maximum size of a text message during parsing.
setMethod(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the HTTP method to use.
setNextIncomingFrames(IncomingFrames) - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: Set the next IncomingFrames to call in the chain.
setNextOutgoingFrames(OutgoingFrames) - Method in interface org.eclipse.jetty.websocket.api.extensions.Extension: Set the next OutgoingFrames to call in the chain.
setParameter(String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
setParameter(String, int) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
setParameter(String, String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
setRequestURI(URI) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the Request URI to use for this request.
setSession(Object) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the Session associated with this request.
setStatusCode(int) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Set the HTTP Response status code
setStatusReason(String) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Set the HTTP Response status reason phrase
setSubProtocols(String...) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the offered WebSocket Sub-Protocol list.
setSubProtocols(List<String>) - Method in interface org.eclipse.jetty.websocket.api.UpgradeRequest: Set the offered WebSocket Sub-Protocol list.
setSuccess(boolean) - Method in interface org.eclipse.jetty.websocket.api.UpgradeResponse: Deprecated.
this has no replacement, will be removed in Jetty 10
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.WebSocketConstants
splitAt(String, String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil: Create an iterator of the input string, breaking apart the string at the provided delimiters, removing quotes and triming the parts of the string as needed.
StatusCode - Class in org.eclipse.jetty.websocket.api: The RFC 6455 specified status codes and IANA: WebSocket Close Code Number Registry
StatusCode() - Constructor for class org.eclipse.jetty.websocket.api.StatusCode
suspend() - Method in interface org.eclipse.jetty.websocket.api.Session: Suspend the incoming read events on the connection.
SuspendToken - Interface in org.eclipse.jetty.websocket.api: Connection suspend token

T

TEXT - org.eclipse.jetty.websocket.api.extensions.Frame.Type
toHeaderValue(List<ExtensionConfig>) - Static method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig: Convert a list of ExtensionConfig to a header value
toHttp(URI) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI: Convert to HTTP http or https scheme URIs.
toString() - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
toString() - Method in enum org.eclipse.jetty.websocket.api.extensions.Frame.Type
toString() - Method in class org.eclipse.jetty.websocket.api.WebSocketPolicy
toWebsocket(CharSequence) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI: Convert to WebSocket ws or wss scheme URIs
toWebsocket(CharSequence, String) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI: Convert to WebSocket ws or wss scheme URIs
toWebsocket(URI) - Static method in class org.eclipse.jetty.websocket.api.util.WSURI: Convert to WebSocket ws or wss scheme URIs
trimMaxReasonLength(String) - Static method in class org.eclipse.jetty.websocket.api.CloseStatus: Deprecated.
use of this method is strongly discouraged, as it creates too many new objects that are just thrown away to accomplish its goals.
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.
unescape(String) - Static method in class org.eclipse.jetty.websocket.api.util.QuoteUtil
unregister(String) - Method in class org.eclipse.jetty.websocket.api.extensions.ExtensionFactory: Deprecated.
UpgradeException - Exception in org.eclipse.jetty.websocket.api: Exception during WebSocket Upgrade Handshake.
UpgradeException(URI, int, String) - Constructor for exception org.eclipse.jetty.websocket.api.UpgradeException
UpgradeException(URI, int, String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.UpgradeException
UpgradeException(URI, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.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.extensions.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.extensions.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
WebSocketConstants() - Constructor for class org.eclipse.jetty.websocket.api.WebSocketConstants
WebSocketException - Exception in org.eclipse.jetty.websocket.api: A recoverable exception within the websocket framework.
WebSocketException() - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketException
WebSocketException(String) - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketException
WebSocketException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketException
WebSocketException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.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 - Class in org.eclipse.jetty.websocket.api: Settings for WebSocket operations.
WebSocketPolicy(WebSocketBehavior) - Constructor for class org.eclipse.jetty.websocket.api.WebSocketPolicy
WebSocketTimeoutException - Exception in org.eclipse.jetty.websocket.api: Exception thrown to indicate a connection I/O timeout.
WebSocketTimeoutException(String) - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketTimeoutException
WebSocketTimeoutException(String, Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketTimeoutException
WebSocketTimeoutException(Throwable) - Constructor for exception org.eclipse.jetty.websocket.api.WebSocketTimeoutException
WriteCallback - Interface in org.eclipse.jetty.websocket.api: Callback for Write events.
writeFailed(Throwable) - Method in interface org.eclipse.jetty.websocket.api.WriteCallback: Callback invoked when the write fails.
writeSuccess() - Method in interface org.eclipse.jetty.websocket.api.WriteCallback: Callback invoked when the write completes.
WSURI - Class in org.eclipse.jetty.websocket.api.util: Utility methods for converting a URI between an HTTP(S) and WS(S) URI.
WSURI() - Constructor for class org.eclipse.jetty.websocket.api.util.WSURI

A B C D E F G H I J M N O P Q R S T U V W
All Classes All Packages