Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABNORMAL_CLOSE - Static variable in class org.java_websocket.framing.CloseFrame
-
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- AbstractWebSocket - Class in org.java_websocket
-
Base class for additional implementations for the server as well as the client
- AbstractWebSocket() - Constructor for class org.java_websocket.AbstractWebSocket
- AbstractWrappedByteChannel - Class in org.java_websocket
-
Deprecated.
- AbstractWrappedByteChannel(ByteChannel) - Constructor for class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- AbstractWrappedByteChannel(WrappedByteChannel) - Constructor for class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft_6455
- acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft
- acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft_6455
- acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft
- acceptProvidedExtensionAsClient(String) - Method in class org.java_websocket.extensions.DefaultExtension
- acceptProvidedExtensionAsClient(String) - Method in interface org.java_websocket.extensions.IExtension
-
Check if the received Sec-WebSocket-Extensions header field contains a offer for the specific extension if the endpoint is in the role of a client
- acceptProvidedExtensionAsClient(String) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- acceptProvidedExtensionAsServer(String) - Method in class org.java_websocket.extensions.DefaultExtension
- acceptProvidedExtensionAsServer(String) - Method in interface org.java_websocket.extensions.IExtension
-
Check if the received Sec-WebSocket-Extensions header field contains a offer for the specific extension if the endpoint is in the role of a server
- acceptProvidedExtensionAsServer(String) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- acceptProvidedProtocol(String) - Method in interface org.java_websocket.protocols.IProtocol
-
Check if the received Sec-WebSocket-Protocol header field contains a offer for the specific protocol
- acceptProvidedProtocol(String) - Method in class org.java_websocket.protocols.Protocol
- addConnection(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- addHeader(String, String) - Method in class org.java_websocket.client.WebSocketClient
- allocateBuffers(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- append(Framedata) - Method in interface org.java_websocket.framing.Framedata
-
Appends an additional frame to the current frame
- append(Framedata) - Method in class org.java_websocket.framing.FramedataImpl1
- asciiBytes(String) - Static method in class org.java_websocket.util.Charsetfunctions
B
- BAD_GATEWAY - Static variable in class org.java_websocket.framing.CloseFrame
-
1014 indicates that the server was acting as a gateway or proxy and received an invalid response from the upstream server.
- Base64 - Class in org.java_websocket.util
-
Encodes and decodes to and from Base64 notation.
- Base64.OutputStream - Class in org.java_websocket.util
-
A
Base64.OutputStream
will write data to anotherjava.io.OutputStream
, given in the constructor, and encode/decode to/from Base64 notation on the fly. - basicAccept(Handshakedata) - Method in class org.java_websocket.drafts.Draft
- batch(WebSocketImpl, ByteChannel) - Static method in class org.java_websocket.SocketChannelIOHelper
-
Returns whether the whole outQueue has been flushed
- BINARY - Enum constant in enum class org.java_websocket.enums.Opcode
- BinaryFrame - Class in org.java_websocket.framing
-
Class to represent a binary frame
- BinaryFrame() - Constructor for class org.java_websocket.framing.BinaryFrame
-
constructor which sets the opcode of this frame to binary
- broadcast(byte[]) - Method in class org.java_websocket.server.WebSocketServer
-
Send a byte array to all connected endpoints
- broadcast(byte[], Collection<WebSocket>) - Method in class org.java_websocket.server.WebSocketServer
-
Send a byte array to a specific collection of websocket connections
- broadcast(String) - Method in class org.java_websocket.server.WebSocketServer
-
Send a text to all connected endpoints
- broadcast(String, Collection<WebSocket>) - Method in class org.java_websocket.server.WebSocketServer
-
Send a text to a specific collection of websocket connections
- broadcast(ByteBuffer) - Method in class org.java_websocket.server.WebSocketServer
-
Send a ByteBuffer to all connected endpoints
- broadcast(ByteBuffer, Collection<WebSocket>) - Method in class org.java_websocket.server.WebSocketServer
-
Send a ByteBuffer to a specific collection of websocket connections
- bufferallocations - Variable in class org.java_websocket.SSLSocketChannel2
-
Should be used to count the buffer allocations.
- BUGGYCLOSE - Static variable in class org.java_websocket.framing.CloseFrame
-
The connection had a buggy close (this should not happen)
- ByteBufferUtils - Class in org.java_websocket.util
-
Utility class for ByteBuffers
C
- Charsetfunctions - Class in org.java_websocket.util
- checkAlloc(int) - Method in class org.java_websocket.drafts.Draft
- clearHeaders() - Method in class org.java_websocket.client.WebSocketClient
- CLIENT - Enum constant in enum class org.java_websocket.enums.Role
- ClientHandshake - Interface in org.java_websocket.handshake
-
The interface for a client handshake
- ClientHandshakeBuilder - Interface in org.java_websocket.handshake
-
The interface for building a handshake for the client
- close() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- close() - Method in class org.java_websocket.client.WebSocketClient
-
Initiates the websocket close handshake.
- close() - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- close() - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
- close() - Method in class org.java_websocket.SSLSocketChannel
- close() - Method in class org.java_websocket.SSLSocketChannel2
- close() - Method in class org.java_websocket.util.Base64.OutputStream
-
Flushes and closes (I think, in the superclass) the stream.
- close() - Method in interface org.java_websocket.WebSocket
-
Convenience function which behaves like close(CloseFrame.NORMAL)
- close() - Method in class org.java_websocket.WebSocketImpl
- close() - Method in interface org.java_websocket.WebSocketServerFactory
-
Allows to shutdown the websocket factory for a clean shutdown
- close(int) - Method in class org.java_websocket.client.WebSocketClient
- close(int) - Method in interface org.java_websocket.WebSocket
-
sends the closing handshake. may be send in response to an other handshake.
- close(int) - Method in class org.java_websocket.WebSocketImpl
- close(int, String) - Method in class org.java_websocket.client.WebSocketClient
- close(int, String) - Method in interface org.java_websocket.WebSocket
-
sends the closing handshake. may be send in response to an other handshake.
- close(int, String) - Method in class org.java_websocket.WebSocketImpl
- close(int, String, boolean) - Method in class org.java_websocket.WebSocketImpl
- close(InvalidDataException) - Method in class org.java_websocket.WebSocketImpl
- closeBlocking() - Method in class org.java_websocket.client.WebSocketClient
-
Same as
close
but blocks until the websocket closed or failed to do so. - closeConnection() - Method in class org.java_websocket.WebSocketImpl
- closeConnection(int, boolean) - Method in class org.java_websocket.WebSocketImpl
- closeConnection(int, String) - Method in class org.java_websocket.client.WebSocketClient
- closeConnection(int, String) - Method in interface org.java_websocket.WebSocket
-
This will close the connection immediately without a proper close handshake.
- closeConnection(int, String) - Method in class org.java_websocket.WebSocketImpl
- closeConnection(int, String, boolean) - Method in class org.java_websocket.WebSocketImpl
-
This will close the connection immediately without a proper close handshake.
- CLOSED - Enum constant in enum class org.java_websocket.enums.ReadyState
- CloseFrame - Class in org.java_websocket.framing
-
Class to represent a close frame
- CloseFrame() - Constructor for class org.java_websocket.framing.CloseFrame
-
Constructor for a close frame
- CloseHandshakeType - Enum Class in org.java_websocket.enums
-
Enum which represents type of handshake is required for a close
- CLOSING - Enum constant in enum class org.java_websocket.enums.Opcode
- CLOSING - Enum constant in enum class org.java_websocket.enums.ReadyState
- CompressionExtension - Class in org.java_websocket.extensions
-
Implementation for a compression extension specified by https://tools.ietf.org/html/rfc7692
- CompressionExtension() - Constructor for class org.java_websocket.extensions.CompressionExtension
- configureBlocking(boolean) - Method in class org.java_websocket.SSLSocketChannel2
- connect() - Method in class org.java_websocket.client.WebSocketClient
-
Initiates the websocket connection.
- connect(SocketAddress) - Method in class org.java_websocket.SSLSocketChannel2
- connectBlocking() - Method in class org.java_websocket.client.WebSocketClient
-
Same as
connect
but blocks until the websocket connected or failed to do so. - connectBlocking(long, TimeUnit) - Method in class org.java_websocket.client.WebSocketClient
-
Same as
connect
but blocks with a timeout until the websocket connected or failed to do so. - consumeDelegatedTasks() - Method in class org.java_websocket.SSLSocketChannel2
- CONTINUOUS - Enum constant in enum class org.java_websocket.enums.Opcode
- continuousFrame(Opcode, ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft
- ContinuousFrame - Class in org.java_websocket.framing
-
Class to represent a continuous frame
- ContinuousFrame() - Constructor for class org.java_websocket.framing.ContinuousFrame
-
constructor which sets the opcode of this frame to continuous
- continuousFrameType - Variable in class org.java_websocket.drafts.Draft
- ControlFrame - Class in org.java_websocket.framing
-
Abstract class to represent control frames
- ControlFrame(Opcode) - Constructor for class org.java_websocket.framing.ControlFrame
-
Class to represent a control frame
- copyInstance() - Method in class org.java_websocket.drafts.Draft_6455
- copyInstance() - Method in class org.java_websocket.drafts.Draft
-
Drafts must only be by one websocket at all.
- copyInstance() - Method in class org.java_websocket.extensions.DefaultExtension
- copyInstance() - Method in interface org.java_websocket.extensions.IExtension
-
Extensions must only be by one websocket at all.
- copyInstance() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- copyInstance() - Method in interface org.java_websocket.protocols.IProtocol
-
To prevent protocols to be used more than once the Websocket implementation should call this method in order to create a new usable version of a given protocol instance.
- copyInstance() - Method in class org.java_websocket.protocols.Protocol
- createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft_6455
- createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft
- createBuffer() - Method in class org.java_websocket.server.WebSocketServer
- createBuffers(SSLSession) - Method in class org.java_websocket.SSLSocketChannel2
- createFrames(String, boolean) - Method in class org.java_websocket.drafts.Draft_6455
- createFrames(String, boolean) - Method in class org.java_websocket.drafts.Draft
- createFrames(ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft_6455
- createFrames(ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft
- createHandshake(Handshakedata) - Method in class org.java_websocket.drafts.Draft
- createHandshake(Handshakedata, boolean) - Method in class org.java_websocket.drafts.Draft
- createHandshake(Handshakedata, Role) - Method in class org.java_websocket.drafts.Draft
-
Deprecated.use createHandshake without the role
- createHandshake(Handshakedata, Role, boolean) - Method in class org.java_websocket.drafts.Draft
-
Deprecated.use createHandshake without the role since it does not have any effect
- createWebSocket(WebSocketAdapter, List<Draft>) - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- createWebSocket(WebSocketAdapter, List<Draft>) - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
- createWebSocket(WebSocketAdapter, List<Draft>) - Method in interface org.java_websocket.WebSocketFactory
-
Create a new Websocket with the provided listener, drafts and socket
- createWebSocket(WebSocketAdapter, List<Draft>) - Method in interface org.java_websocket.WebSocketServerFactory
- createWebSocket(WebSocketAdapter, Draft) - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- createWebSocket(WebSocketAdapter, Draft) - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
- createWebSocket(WebSocketAdapter, Draft) - Method in interface org.java_websocket.WebSocketFactory
-
Create a new Websocket with the provided listener, drafts and socket
- createWebSocket(WebSocketAdapter, Draft) - Method in interface org.java_websocket.WebSocketServerFactory
- CustomSSLWebSocketServerFactory - Class in org.java_websocket.server
-
WebSocketFactory that can be configured to only support specific protocols and cipher suites.
- CustomSSLWebSocketServerFactory(SSLContext, String[], String[]) - Constructor for class org.java_websocket.server.CustomSSLWebSocketServerFactory
-
New CustomSSLWebSocketServerFactory configured to only support given protocols and given cipher suites.
- CustomSSLWebSocketServerFactory(SSLContext, ExecutorService, String[], String[]) - Constructor for class org.java_websocket.server.CustomSSLWebSocketServerFactory
-
New CustomSSLWebSocketServerFactory configured to only support given protocols and given cipher suites.
D
- DataFrame - Class in org.java_websocket.framing
-
Abstract class to represent data frames
- DataFrame(Opcode) - Constructor for class org.java_websocket.framing.DataFrame
-
Class to represent a data frame
- decode(ByteBuffer) - Method in class org.java_websocket.WebSocketImpl
-
Method to decode the provided ByteBuffer
- decodeFrame(Framedata) - Method in class org.java_websocket.extensions.DefaultExtension
- decodeFrame(Framedata) - Method in interface org.java_websocket.extensions.IExtension
-
Decode a frame with a extension specific algorithm.
- decodeFrame(Framedata) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- decoders - Variable in class org.java_websocket.server.WebSocketServer
- DEFAULT_PORT - Static variable in class org.java_websocket.WebSocketImpl
-
The default port of WebSockets, as defined in the spec.
- DEFAULT_READ_BUFFER_SIZE - Static variable in class org.java_websocket.AbstractWebSocket
-
Used for internal buffer allocations when the socket buffer size is not specified.
- DEFAULT_WSS_PORT - Static variable in class org.java_websocket.WebSocketImpl
-
The default wss port of WebSockets, as defined in the spec.
- DefaultExtension - Class in org.java_websocket.extensions
-
Class which represents the normal websocket implementation specified by rfc6455.
- DefaultExtension() - Constructor for class org.java_websocket.extensions.DefaultExtension
- DefaultSSLWebSocketServerFactory - Class in org.java_websocket.server
- DefaultSSLWebSocketServerFactory(SSLContext) - Constructor for class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- DefaultSSLWebSocketServerFactory(SSLContext, ExecutorService) - Constructor for class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- DefaultWebSocketServerFactory - Class in org.java_websocket.server
- DefaultWebSocketServerFactory() - Constructor for class org.java_websocket.server.DefaultWebSocketServerFactory
- DnsResolver - Interface in org.java_websocket.client
-
Users may implement this interface to override the default DNS lookup offered by the OS.
- DO_BREAK_LINES - Static variable in class org.java_websocket.util.Base64
-
Do break lines when encoding.
- Draft - Class in org.java_websocket.drafts
-
Base class for everything of a websocket specification which is not common such as the way the handshake is read or frames are transferred.
- Draft() - Constructor for class org.java_websocket.drafts.Draft
- Draft_6455 - Class in org.java_websocket.drafts
-
Implementation for the RFC 6455 websocket protocol This is the recommended class for your websocket connection
- Draft_6455() - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with default extensions
- Draft_6455(List<IExtension>) - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with custom extensions
- Draft_6455(List<IExtension>, int) - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with custom extensions and protocols
- Draft_6455(List<IExtension>, List<IProtocol>) - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with custom extensions and protocols
- Draft_6455(List<IExtension>, List<IProtocol>, int) - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with custom extensions and protocols
- Draft_6455(IExtension) - Constructor for class org.java_websocket.drafts.Draft_6455
-
Constructor for the websocket protocol specified by RFC 6455 with custom extensions
E
- EMPTY_VALUE - Static variable in class org.java_websocket.extensions.ExtensionRequestData
- emptybuffer - Static variable in class org.java_websocket.SSLSocketChannel2
-
This object is used to feed the
SSLEngine
's wrap and unwrap methods during the handshake phase. - ENCODE - Static variable in class org.java_websocket.util.Base64
-
Specify encoding in first bit.
- encodeBytes(byte[]) - Static method in class org.java_websocket.util.Base64
-
Encodes a byte array into Base64 notation.
- encodeBytes(byte[], int, int, int) - Static method in class org.java_websocket.util.Base64
-
Encodes a byte array into Base64 notation.
- encodeBytesToBytes(byte[], int, int, int) - Static method in class org.java_websocket.util.Base64
-
Similar to
Base64.encodeBytes(byte[], int, int, int)
but returns a byte array instead of instantiating a String. - encodeFrame(Framedata) - Method in class org.java_websocket.extensions.DefaultExtension
- encodeFrame(Framedata) - Method in interface org.java_websocket.extensions.IExtension
-
Encode a frame with a extension specific algorithm.
- encodeFrame(Framedata) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- eot() - Method in class org.java_websocket.WebSocketImpl
- equals(Object) - Method in class org.java_websocket.drafts.Draft_6455
- equals(Object) - Method in class org.java_websocket.extensions.DefaultExtension
- equals(Object) - Method in class org.java_websocket.framing.CloseFrame
- equals(Object) - Method in class org.java_websocket.framing.FramedataImpl1
- equals(Object) - Method in class org.java_websocket.protocols.Protocol
- exec - Variable in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- exec - Variable in class org.java_websocket.SSLSocketChannel2
- EXTENSION - Static variable in class org.java_websocket.framing.CloseFrame
-
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.
- ExtensionRequestData - Class in org.java_websocket.extensions
F
- finishConnect() - Method in class org.java_websocket.SSLSocketChannel2
- FLASHPOLICY - Static variable in class org.java_websocket.framing.CloseFrame
-
The connection was flushed and closed
- flushAndClose(int, String, boolean) - Method in class org.java_websocket.WebSocketImpl
- flushBase64() - Method in class org.java_websocket.util.Base64.OutputStream
-
Method added by PHIL.
- Framedata - Interface in org.java_websocket.framing
-
The interface for the frame
- FramedataImpl1 - Class in org.java_websocket.framing
-
Abstract implementation of a frame
- FramedataImpl1(Opcode) - Constructor for class org.java_websocket.framing.FramedataImpl1
-
Constructor for a FramedataImpl without any attributes set apart from the opcode
G
- get(Opcode) - Static method in class org.java_websocket.framing.FramedataImpl1
-
Get a frame with a specific opcode
- getAddress() - Method in class org.java_websocket.server.WebSocketServer
- getAttachment() - Method in class org.java_websocket.client.WebSocketClient
- getAttachment() - Method in interface org.java_websocket.WebSocket
-
Getter for the connection attachment.
- getAttachment() - Method in class org.java_websocket.WebSocketImpl
- getChannel() - Method in class org.java_websocket.WebSocketImpl
- getCloseCode() - Method in exception class org.java_websocket.exceptions.InvalidDataException
-
Getter closecode
- getCloseCode() - Method in class org.java_websocket.framing.CloseFrame
-
Get the used close code
- getCloseHandshakeType() - Method in class org.java_websocket.drafts.Draft_6455
- getCloseHandshakeType() - Method in class org.java_websocket.drafts.Draft
- getConnection() - Method in class org.java_websocket.client.WebSocketClient
-
Getter for the engine
- getConnection() - Method in exception class org.java_websocket.exceptions.WrappedIOException
-
The websocket where the IOException happened
- getConnectionLostTimeout() - Method in class org.java_websocket.AbstractWebSocket
-
Get the interval checking for lost connections Default is 60 seconds
- getConnections() - Method in class org.java_websocket.AbstractWebSocket
-
Getter to get all the currently available connections
- getConnections() - Method in class org.java_websocket.client.WebSocketClient
- getConnections() - Method in class org.java_websocket.server.WebSocketServer
-
Returns all currently connected clients.
- getContent() - Method in interface org.java_websocket.handshake.Handshakedata
-
Get the content of the handshake
- getContent() - Method in class org.java_websocket.handshake.HandshakedataImpl1
- getDeflater() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- getDraft() - Method in class org.java_websocket.client.WebSocketClient
-
Returns the protocol version this channel uses.
For more infos see https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts - getDraft() - Method in class org.java_websocket.server.WebSocketServer
-
Get the list of active drafts
- getDraft() - Method in interface org.java_websocket.WebSocket
-
Getter for the draft
- getDraft() - Method in class org.java_websocket.WebSocketImpl
- getEmptyByteBuffer() - Static method in class org.java_websocket.util.ByteBufferUtils
-
Get a ByteBuffer with zero capacity
- getEncodingException() - Method in exception class org.java_websocket.exceptions.InvalidEncodingException
-
Get the exception which includes more information on the unsupported encoding
- getExtension() - Method in class org.java_websocket.drafts.Draft_6455
-
Getter for the extension which is used by this draft
- getExtensionName() - Method in class org.java_websocket.extensions.ExtensionRequestData
- getExtensionParameters() - Method in class org.java_websocket.extensions.ExtensionRequestData
- getFieldValue(String) - Method in interface org.java_websocket.handshake.Handshakedata
-
Gets the value of the field
- getFieldValue(String) - Method in class org.java_websocket.handshake.HandshakedataImpl1
- getHttpStatus() - Method in class org.java_websocket.handshake.HandshakeImpl1Server
- getHttpStatus() - Method in interface org.java_websocket.handshake.ServerHandshake
-
Get the http status code
- getHttpStatusMessage() - Method in class org.java_websocket.handshake.HandshakeImpl1Server
- getHttpStatusMessage() - Method in interface org.java_websocket.handshake.ServerHandshake
-
Get the http status message
- getInflater() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- getIOException() - Method in exception class org.java_websocket.exceptions.WrappedIOException
-
The wrapped IOException
- getKnownExtensions() - Method in class org.java_websocket.drafts.Draft_6455
-
Getter for all available extensions for this draft
- getKnownProtocols() - Method in class org.java_websocket.drafts.Draft_6455
-
Getter for all available protocols for this draft
- getLimit() - Method in exception class org.java_websocket.exceptions.LimitExceededException
-
Get the limit which was hit so this exception was caused
- getLocalSocketAddress() - Method in class org.java_websocket.client.WebSocketClient
- getLocalSocketAddress() - Method in interface org.java_websocket.WebSocket
-
Returns the address of the endpoint this socket is bound to, or
null
if it is not bound. - getLocalSocketAddress() - Method in class org.java_websocket.WebSocketImpl
- getLocalSocketAddress(WebSocket) - Method in class org.java_websocket.client.WebSocketClient
- getLocalSocketAddress(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- getLocalSocketAddress(WebSocket) - Method in interface org.java_websocket.WebSocketListener
- getMaxFrameSize() - Method in class org.java_websocket.drafts.Draft_6455
-
Getter for the maximum allowed payload size which is used by this draft
- getMaxPendingConnections() - Method in class org.java_websocket.server.WebSocketServer
-
Returns the currently configured maximum number of pending connections.
- getMessage() - Method in class org.java_websocket.framing.CloseFrame
-
Get the message that closeframe is containing
- getOpcode() - Method in interface org.java_websocket.framing.Framedata
-
Defines the interpretation of the "Payload data".
- getOpcode() - Method in class org.java_websocket.framing.FramedataImpl1
- getPayloadData() - Method in class org.java_websocket.framing.CloseFrame
- getPayloadData() - Method in interface org.java_websocket.framing.Framedata
-
The "Payload data" which was sent in this frame
- getPayloadData() - Method in class org.java_websocket.framing.FramedataImpl1
- getPort() - Method in class org.java_websocket.server.WebSocketServer
-
Gets the port number that this server listens on.
- getPreferredSize() - Method in exception class org.java_websocket.exceptions.IncompleteException
-
Getter for the preferredSize
- getPreferredSize() - Method in exception class org.java_websocket.exceptions.IncompleteHandshakeException
-
Getter preferredSize
- getProtocol() - Method in class org.java_websocket.client.WebSocketClient
- getProtocol() - Method in class org.java_websocket.drafts.Draft_6455
-
Getter for the protocol which is used by this draft
- getProtocol() - Method in interface org.java_websocket.WebSocket
-
Returns the used Sec-WebSocket-Protocol for this websocket connection
- getProtocol() - Method in class org.java_websocket.WebSocketImpl
- getProvidedExtensionAsClient() - Method in class org.java_websocket.extensions.DefaultExtension
- getProvidedExtensionAsClient() - Method in interface org.java_websocket.extensions.IExtension
-
Return the specific Sec-WebSocket-Extensions header offer for this extension if the endpoint is in the role of a client.
- getProvidedExtensionAsClient() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- getProvidedExtensionAsServer() - Method in class org.java_websocket.extensions.DefaultExtension
- getProvidedExtensionAsServer() - Method in interface org.java_websocket.extensions.IExtension
-
Return the specific Sec-WebSocket-Extensions header offer for this extension if the endpoint is in the role of a server.
- getProvidedExtensionAsServer() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- getProvidedProtocol() - Method in interface org.java_websocket.protocols.IProtocol
-
Return the specific Sec-WebSocket-protocol header offer for this protocol if the endpoint.
- getProvidedProtocol() - Method in class org.java_websocket.protocols.Protocol
- getReadyState() - Method in class org.java_websocket.client.WebSocketClient
-
This represents the state of the connection.
- getReadyState() - Method in interface org.java_websocket.WebSocket
-
Retrieve the WebSocket 'ReadyState'.
- getReadyState() - Method in class org.java_websocket.WebSocketImpl
- getReceiveBufferSize() - Method in class org.java_websocket.AbstractWebSocket
-
Returns the TCP receive buffer size that will be used for sockets (or zero, if not explicitly set).
- getRemoteSocketAddress() - Method in class org.java_websocket.client.WebSocketClient
- getRemoteSocketAddress() - Method in interface org.java_websocket.WebSocket
-
Returns the address of the endpoint this socket is connected to, or
null
if it is unconnected. - getRemoteSocketAddress() - Method in class org.java_websocket.WebSocketImpl
- getRemoteSocketAddress(WebSocket) - Method in class org.java_websocket.client.WebSocketClient
- getRemoteSocketAddress(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- getRemoteSocketAddress(WebSocket) - Method in interface org.java_websocket.WebSocketListener
- getResourceDescriptor() - Method in class org.java_websocket.client.WebSocketClient
- getResourceDescriptor() - Method in interface org.java_websocket.handshake.ClientHandshake
-
returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
- getResourceDescriptor() - Method in class org.java_websocket.handshake.HandshakeImpl1Client
- getResourceDescriptor() - Method in interface org.java_websocket.WebSocket
-
Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
If the opening handshake has not yet happened it will return null. - getResourceDescriptor() - Method in class org.java_websocket.WebSocketImpl
- getRole() - Method in class org.java_websocket.drafts.Draft
- getSelectionKey() - Method in class org.java_websocket.WebSocketImpl
- getSocket() - Method in class org.java_websocket.client.WebSocketClient
-
Returns the socket to allow Hostname Verification
- getSSLEngine() - Method in interface org.java_websocket.interfaces.ISSLChannel
-
Get the ssl engine used for the de- and encryption of the communication.
- getSSLEngine() - Method in class org.java_websocket.SSLSocketChannel
- getSSLEngine() - Method in class org.java_websocket.SSLSocketChannel2
- getSSLSession() - Method in class org.java_websocket.client.WebSocketClient
- getSSLSession() - Method in interface org.java_websocket.WebSocket
-
Returns the ssl session of websocket, if ssl/wss is used for this instance.
- getSSLSession() - Method in class org.java_websocket.WebSocketImpl
- getThreshold() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Get the size threshold for doing the compression
- getTransfereMasked() - Method in interface org.java_websocket.framing.Framedata
-
Defines whether the "Payload data" is masked.
- getTransfereMasked() - Method in class org.java_websocket.framing.FramedataImpl1
- getURI() - Method in class org.java_websocket.client.WebSocketClient
-
Returns the URI that this WebSocketClient is connected to.
- getWebSocketFactory() - Method in class org.java_websocket.server.WebSocketServer
- getWebSocketListener() - Method in class org.java_websocket.WebSocketImpl
-
Getter for the websocket listener
- getWorkerThread() - Method in class org.java_websocket.WebSocketImpl
- GOING_AWAY - Static variable in class org.java_websocket.framing.CloseFrame
-
1001 indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.
- GZIP - Static variable in class org.java_websocket.util.Base64
-
Specify that data should be gzip-compressed in second bit.
H
- HandshakeBuilder - Interface in org.java_websocket.handshake
-
The interface for building a handshake
- Handshakedata - Interface in org.java_websocket.handshake
-
The interface for the data of a handshake
- HandshakedataImpl1 - Class in org.java_websocket.handshake
-
Implementation of a handshake builder
- HandshakedataImpl1() - Constructor for class org.java_websocket.handshake.HandshakedataImpl1
-
Constructor for handshake implementation
- HandshakeImpl1Client - Class in org.java_websocket.handshake
-
Implementation for a client handshake
- HandshakeImpl1Client() - Constructor for class org.java_websocket.handshake.HandshakeImpl1Client
- HandshakeImpl1Server - Class in org.java_websocket.handshake
-
Implementation for a server handshake
- HandshakeImpl1Server() - Constructor for class org.java_websocket.handshake.HandshakeImpl1Server
- HandshakeState - Enum Class in org.java_websocket.enums
-
Enum which represents the states a handshake may be in
- hasBufferedData() - Method in class org.java_websocket.client.WebSocketClient
- hasBufferedData() - Method in interface org.java_websocket.WebSocket
-
Checks if the websocket has buffered data
- hasBufferedData() - Method in class org.java_websocket.WebSocketImpl
- hasFieldValue(String) - Method in interface org.java_websocket.handshake.Handshakedata
-
Checks if this handshake contains a specific field
- hasFieldValue(String) - Method in class org.java_websocket.handshake.HandshakedataImpl1
- hashCode() - Method in class org.java_websocket.drafts.Draft_6455
- hashCode() - Method in class org.java_websocket.extensions.DefaultExtension
- hashCode() - Method in class org.java_websocket.framing.CloseFrame
- hashCode() - Method in class org.java_websocket.framing.FramedataImpl1
- hashCode() - Method in class org.java_websocket.protocols.Protocol
- hasSSLSupport() - Method in class org.java_websocket.client.WebSocketClient
- hasSSLSupport() - Method in interface org.java_websocket.WebSocket
-
Does this websocket use an encrypted (wss/ssl) or unencrypted (ws) connection
- hasSSLSupport() - Method in class org.java_websocket.WebSocketImpl
I
- IExtension - Interface in org.java_websocket.extensions
-
Interface which specifies all required methods to develop a websocket extension.
- IncompleteException - Exception Class in org.java_websocket.exceptions
-
Exception which indicates that the frame is not yet complete
- IncompleteException(int) - Constructor for exception class org.java_websocket.exceptions.IncompleteException
-
Constructor for the preferred size of a frame
- IncompleteHandshakeException - Exception Class in org.java_websocket.exceptions
-
exception which indicates that a incomplete handshake was received
- IncompleteHandshakeException() - Constructor for exception class org.java_websocket.exceptions.IncompleteHandshakeException
-
constructor for a IncompleteHandshakeException
- IncompleteHandshakeException(int) - Constructor for exception class org.java_websocket.exceptions.IncompleteHandshakeException
-
constructor for a IncompleteHandshakeException
- inCrypt - Variable in class org.java_websocket.SSLSocketChannel2
-
encrypted data incoming
- inData - Variable in class org.java_websocket.SSLSocketChannel2
-
raw payload incoming
- inQueue - Variable in class org.java_websocket.WebSocketImpl
-
Queue of buffers that need to be processed
- InvalidDataException - Exception Class in org.java_websocket.exceptions
-
exception which indicates that a invalid data was received
- InvalidDataException(int) - Constructor for exception class org.java_websocket.exceptions.InvalidDataException
-
constructor for a InvalidDataException
- InvalidDataException(int, String) - Constructor for exception class org.java_websocket.exceptions.InvalidDataException
-
constructor for a InvalidDataException.
- InvalidDataException(int, String, Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidDataException
-
constructor for a InvalidDataException.
- InvalidDataException(int, Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidDataException
-
constructor for a InvalidDataException.
- InvalidEncodingException - Exception Class in org.java_websocket.exceptions
-
The Character Encoding is not supported.
- InvalidEncodingException(UnsupportedEncodingException) - Constructor for exception class org.java_websocket.exceptions.InvalidEncodingException
-
constructor for InvalidEncodingException
- InvalidFrameException - Exception Class in org.java_websocket.exceptions
-
exception which indicates that a invalid frame was received (CloseFrame.PROTOCOL_ERROR)
- InvalidFrameException() - Constructor for exception class org.java_websocket.exceptions.InvalidFrameException
-
constructor for a InvalidFrameException
- InvalidFrameException(String) - Constructor for exception class org.java_websocket.exceptions.InvalidFrameException
-
constructor for a InvalidFrameException
- InvalidFrameException(String, Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidFrameException
-
constructor for a InvalidFrameException
- InvalidFrameException(Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidFrameException
-
constructor for a InvalidFrameException
- InvalidHandshakeException - Exception Class in org.java_websocket.exceptions
-
exception which indicates that a invalid handshake was received (CloseFrame.PROTOCOL_ERROR)
- InvalidHandshakeException() - Constructor for exception class org.java_websocket.exceptions.InvalidHandshakeException
-
constructor for a InvalidHandshakeException
- InvalidHandshakeException(String) - Constructor for exception class org.java_websocket.exceptions.InvalidHandshakeException
-
constructor for a InvalidHandshakeException
- InvalidHandshakeException(String, Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidHandshakeException
-
constructor for a InvalidHandshakeException
- InvalidHandshakeException(Throwable) - Constructor for exception class org.java_websocket.exceptions.InvalidHandshakeException
-
constructor for a InvalidHandshakeException
- IProtocol - Interface in org.java_websocket.protocols
-
Interface which specifies all required methods for a Sec-WebSocket-Protocol
- isBlocking() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- isBlocking() - Method in class org.java_websocket.SSLSocketChannel
- isBlocking() - Method in class org.java_websocket.SSLSocketChannel2
- isBlocking() - Method in interface org.java_websocket.WrappedByteChannel
-
This function returns the blocking state of the channel
- isClientNoContextTakeover() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Access the "client_no_context_takeover" extension parameter
- isClosed() - Method in class org.java_websocket.client.WebSocketClient
- isClosed() - Method in interface org.java_websocket.WebSocket
-
Is the websocket in the state CLOSED
- isClosed() - Method in class org.java_websocket.WebSocketImpl
- isClosing() - Method in class org.java_websocket.client.WebSocketClient
- isClosing() - Method in interface org.java_websocket.WebSocket
-
Is the websocket in the state CLOSING
- isClosing() - Method in class org.java_websocket.WebSocketImpl
- isConnected() - Method in class org.java_websocket.SSLSocketChannel2
- isDaemon() - Method in class org.java_websocket.AbstractWebSocket
-
Getter for daemon
- isFin() - Method in interface org.java_websocket.framing.Framedata
-
Indicates that this is the final fragment in a message.
- isFin() - Method in class org.java_websocket.framing.FramedataImpl1
- isFlushAndClose() - Method in class org.java_websocket.client.WebSocketClient
- isFlushAndClose() - Method in interface org.java_websocket.WebSocket
-
Returns true when no further frames may be submitted
This happens before the socket connection is closed. - isFlushAndClose() - Method in class org.java_websocket.WebSocketImpl
- isFrameValid(Framedata) - Method in class org.java_websocket.extensions.CompressionExtension
- isFrameValid(Framedata) - Method in class org.java_websocket.extensions.DefaultExtension
- isFrameValid(Framedata) - Method in interface org.java_websocket.extensions.IExtension
-
Check if the received frame is correctly implemented by the other endpoint and there are no specification errors (like wrongly set RSV)
- isFrameValid(Framedata) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
This extension requires the RSV1 bit to be set only for the first frame.
- isInboundDone() - Method in class org.java_websocket.SSLSocketChannel2
- isNeedRead() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- isNeedRead() - Method in class org.java_websocket.SSLSocketChannel
- isNeedRead() - Method in class org.java_websocket.SSLSocketChannel2
- isNeedRead() - Method in interface org.java_websocket.WrappedByteChannel
-
returns whether readMore should be called to fetch data which has been decoded but not yet been returned.
- isNeedWrite() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- isNeedWrite() - Method in class org.java_websocket.SSLSocketChannel
- isNeedWrite() - Method in class org.java_websocket.SSLSocketChannel2
- isNeedWrite() - Method in interface org.java_websocket.WrappedByteChannel
-
returns whether writeMore should be called write additional data.
- isOpen() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- isOpen() - Method in class org.java_websocket.client.WebSocketClient
- isOpen() - Method in class org.java_websocket.SSLSocketChannel
- isOpen() - Method in class org.java_websocket.SSLSocketChannel2
- isOpen() - Method in interface org.java_websocket.WebSocket
-
Is the websocket in the state OPEN
- isOpen() - Method in class org.java_websocket.WebSocketImpl
- isReuseAddr() - Method in class org.java_websocket.AbstractWebSocket
-
Tests Tests if SO_REUSEADDR is enabled.
- isRSV1() - Method in interface org.java_websocket.framing.Framedata
-
Indicates that this frame has the rsv1 bit set.
- isRSV1() - Method in class org.java_websocket.framing.FramedataImpl1
- isRSV2() - Method in interface org.java_websocket.framing.Framedata
-
Indicates that this frame has the rsv2 bit set.
- isRSV2() - Method in class org.java_websocket.framing.FramedataImpl1
- isRSV3() - Method in interface org.java_websocket.framing.Framedata
-
Indicates that this frame has the rsv3 bit set.
- isRSV3() - Method in class org.java_websocket.framing.FramedataImpl1
- isServerNoContextTakeover() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Access the "server_no_context_takeover" extension parameter
- ISSLChannel - Interface in org.java_websocket.interfaces
-
Interface which specifies all required methods a SSLSocketChannel has to make public.
- isTcpNoDelay() - Method in class org.java_websocket.AbstractWebSocket
-
Tests if TCP_NODELAY is enabled.
- isValid() - Method in class org.java_websocket.framing.CloseFrame
- isValid() - Method in class org.java_websocket.framing.ControlFrame
- isValid() - Method in class org.java_websocket.framing.DataFrame
- isValid() - Method in class org.java_websocket.framing.FramedataImpl1
-
Check if the frame is valid due to specification
- isValid() - Method in class org.java_websocket.framing.TextFrame
- isValidUTF8(ByteBuffer) - Static method in class org.java_websocket.util.Charsetfunctions
-
Calling isValidUTF8 with offset 0
- isValidUTF8(ByteBuffer, int) - Static method in class org.java_websocket.util.Charsetfunctions
-
Check if the provided BytebBuffer contains a valid utf8 encoded string.
- iterateHttpFields() - Method in interface org.java_websocket.handshake.Handshakedata
-
Iterator for the http fields
- iterateHttpFields() - Method in class org.java_websocket.handshake.HandshakedataImpl1
L
- LimitExceededException - Exception Class in org.java_websocket.exceptions
-
exception which indicates that the message limited was exceeded (CloseFrame.TOOBIG)
- LimitExceededException() - Constructor for exception class org.java_websocket.exceptions.LimitExceededException
-
constructor for a LimitExceededException
- LimitExceededException(int) - Constructor for exception class org.java_websocket.exceptions.LimitExceededException
-
constructor for a LimitExceededException
- LimitExceededException(String) - Constructor for exception class org.java_websocket.exceptions.LimitExceededException
-
constructor for a LimitExceededException
- LimitExceededException(String, int) - Constructor for exception class org.java_websocket.exceptions.LimitExceededException
-
constructor for a LimitExceededException
M
- MATCHED - Enum constant in enum class org.java_websocket.enums.HandshakeState
-
Handshake matched this Draft successfully
N
- NamedThreadFactory - Class in org.java_websocket.util
- NamedThreadFactory(String) - Constructor for class org.java_websocket.util.NamedThreadFactory
- NamedThreadFactory(String, boolean) - Constructor for class org.java_websocket.util.NamedThreadFactory
- NEVER_CONNECTED - Static variable in class org.java_websocket.framing.CloseFrame
-
The connection had never been established
- newThread(Runnable) - Method in class org.java_websocket.util.NamedThreadFactory
- NO_OPTIONS - Static variable in class org.java_websocket.util.Base64
-
No options specified.
- NO_UTF8 - Static variable in class org.java_websocket.framing.CloseFrame
-
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).
- NOCODE - Static variable in class org.java_websocket.framing.CloseFrame
-
1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NONE - Enum constant in enum class org.java_websocket.enums.CloseHandshakeType
- NORMAL - Static variable in class org.java_websocket.framing.CloseFrame
-
indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.
- NOT_MATCHED - Enum constant in enum class org.java_websocket.enums.HandshakeState
-
Handshake is does not match this Draft
- NOT_YET_CONNECTED - Enum constant in enum class org.java_websocket.enums.ReadyState
- NotSendableException - Exception Class in org.java_websocket.exceptions
-
exception which indicates the frame payload is not sendable
- NotSendableException(String) - Constructor for exception class org.java_websocket.exceptions.NotSendableException
-
constructor for a NotSendableException
- NotSendableException(String, Throwable) - Constructor for exception class org.java_websocket.exceptions.NotSendableException
-
constructor for a NotSendableException
- NotSendableException(Throwable) - Constructor for exception class org.java_websocket.exceptions.NotSendableException
-
constructor for a NotSendableException
O
- onClose(int, String, boolean) - Method in class org.java_websocket.client.WebSocketClient
-
Called after the websocket connection has been closed.
- onClose(WebSocket, int, String, boolean) - Method in class org.java_websocket.server.WebSocketServer
-
Called after the websocket connection has been closed.
- onCloseInitiated(int, String) - Method in class org.java_websocket.client.WebSocketClient
-
Send when this peer sends a close handshake
- onCloseInitiated(WebSocket, int, String) - Method in class org.java_websocket.server.WebSocketServer
- onClosing(int, String, boolean) - Method in class org.java_websocket.client.WebSocketClient
-
Called as soon as no further frames are accepted
- onClosing(WebSocket, int, String, boolean) - Method in class org.java_websocket.server.WebSocketServer
- onConnect(SelectionKey) - Method in class org.java_websocket.server.WebSocketServer
-
Returns whether a new connection shall be accepted or not.
Therefore method is well suited to implement some kind of connection limitation. - onError(Exception) - Method in class org.java_websocket.client.WebSocketClient
-
Called when errors occurs.
- onError(WebSocket, Exception) - Method in class org.java_websocket.server.WebSocketServer
-
Called when errors occurs.
- ONEWAY - Enum constant in enum class org.java_websocket.enums.CloseHandshakeType
- onMessage(String) - Method in class org.java_websocket.client.WebSocketClient
-
Callback for string messages received from the remote host
- onMessage(ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
-
Callback for binary messages received from the remote host
- onMessage(WebSocket, String) - Method in class org.java_websocket.server.WebSocketServer
-
Callback for string messages received from the remote host
- onMessage(WebSocket, ByteBuffer) - Method in class org.java_websocket.server.WebSocketServer
-
Callback for binary messages received from the remote host
- onOpen(ServerHandshake) - Method in class org.java_websocket.client.WebSocketClient
-
Called after an opening handshake has been performed and the given websocket is ready to be written on.
- onOpen(WebSocket, ClientHandshake) - Method in class org.java_websocket.server.WebSocketServer
-
Called after an opening handshake has been performed and the given websocket is ready to be written on.
- onPreparePing(WebSocket) - Method in class org.java_websocket.WebSocketAdapter
-
Default implementation for onPreparePing, returns a (cached) PingFrame that has no application data.
- onPreparePing(WebSocket) - Method in interface org.java_websocket.WebSocketListener
-
Called just before a ping frame is sent, in order to allow users to customize their ping frame data.
- onSetSSLParameters(SSLParameters) - Method in class org.java_websocket.client.WebSocketClient
-
Apply specific SSLParameters If you override this method make sure to always call super.onSetSSLParameters() to ensure the hostname validation is active
- onStart() - Method in class org.java_websocket.server.WebSocketServer
-
Called when the server started up successfully.
- onWebsocketClose(WebSocket, int, String, boolean) - Method in class org.java_websocket.client.WebSocketClient
-
Calls subclass' implementation of onClose.
- onWebsocketClose(WebSocket, int, String, boolean) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketClose(WebSocket, int, String, boolean) - Method in interface org.java_websocket.WebSocketListener
-
Called after
WebSocket#close
is explicity called, or when the other end of the WebSocket connection is closed. - onWebsocketCloseInitiated(WebSocket, int, String) - Method in class org.java_websocket.client.WebSocketClient
- onWebsocketCloseInitiated(WebSocket, int, String) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketCloseInitiated(WebSocket, int, String) - Method in interface org.java_websocket.WebSocketListener
-
send when this peer sends a close handshake
- onWebsocketClosing(WebSocket, int, String, boolean) - Method in class org.java_websocket.client.WebSocketClient
- onWebsocketClosing(WebSocket, int, String, boolean) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketClosing(WebSocket, int, String, boolean) - Method in interface org.java_websocket.WebSocketListener
-
Called as soon as no further frames are accepted
- onWebsocketError(WebSocket, Exception) - Method in class org.java_websocket.client.WebSocketClient
-
Calls subclass' implementation of onIOError.
- onWebsocketError(WebSocket, Exception) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketError(WebSocket, Exception) - Method in interface org.java_websocket.WebSocketListener
-
Called if an exception worth noting occurred.
- onWebsocketHandshakeReceivedAsClient(WebSocket, ClientHandshake, ServerHandshake) - Method in class org.java_websocket.WebSocketAdapter
- onWebsocketHandshakeReceivedAsClient(WebSocket, ClientHandshake, ServerHandshake) - Method in interface org.java_websocket.WebSocketListener
-
Called on the client side when the socket connection is first established, and the WebSocketImpl handshake response has been received.
- onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake) - Method in class org.java_websocket.WebSocketAdapter
-
This default implementation does not do anything.
- onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake) - Method in interface org.java_websocket.WebSocketListener
-
Called on the server side when the socket connection is first established, and the WebSocket handshake has been received.
- onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake) - Method in class org.java_websocket.WebSocketAdapter
-
This default implementation does not do anything which will cause the connections to always progress.
- onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake) - Method in interface org.java_websocket.WebSocketListener
-
Called on the client side when the socket connection is first established, and the WebSocketImpl handshake has just been sent.
- onWebsocketMessage(WebSocket, String) - Method in class org.java_websocket.client.WebSocketClient
-
Calls subclass' implementation of onMessage.
- onWebsocketMessage(WebSocket, String) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketMessage(WebSocket, String) - Method in interface org.java_websocket.WebSocketListener
-
Called when an entire text frame has been received.
- onWebsocketMessage(WebSocket, ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
- onWebsocketMessage(WebSocket, ByteBuffer) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketMessage(WebSocket, ByteBuffer) - Method in interface org.java_websocket.WebSocketListener
-
Called when an entire binary frame has been received.
- onWebsocketOpen(WebSocket, Handshakedata) - Method in class org.java_websocket.client.WebSocketClient
-
Calls subclass' implementation of onOpen.
- onWebsocketOpen(WebSocket, Handshakedata) - Method in class org.java_websocket.server.WebSocketServer
- onWebsocketOpen(WebSocket, Handshakedata) - Method in interface org.java_websocket.WebSocketListener
-
Called after onHandshakeReceived returns true.
- onWebsocketPing(WebSocket, Framedata) - Method in class org.java_websocket.WebSocketAdapter
-
This default implementation will send a pong in response to the received ping.
- onWebsocketPing(WebSocket, Framedata) - Method in interface org.java_websocket.WebSocketListener
-
Called a ping frame has been received.
- onWebsocketPong(WebSocket, Framedata) - Method in class org.java_websocket.WebSocketAdapter
-
This default implementation does not do anything.
- onWebsocketPong(WebSocket, Framedata) - Method in interface org.java_websocket.WebSocketListener
-
Called when a pong frame is received.
- onWriteDemand(WebSocket) - Method in class org.java_websocket.client.WebSocketClient
- onWriteDemand(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- onWriteDemand(WebSocket) - Method in interface org.java_websocket.WebSocketListener
-
This method is used to inform the selector thread that there is data queued to be written to the socket.
- Opcode - Enum Class in org.java_websocket.enums
-
Enum which contains the different valid opcodes
- OPEN - Enum constant in enum class org.java_websocket.enums.ReadyState
- ORDERED - Static variable in class org.java_websocket.util.Base64
-
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
- org.java_websocket - package org.java_websocket
- org.java_websocket.client - package org.java_websocket.client
-
This package encapsulates all implementations in relation with the WebSocketClient.
- org.java_websocket.drafts - package org.java_websocket.drafts
-
This package encapsulates all implementations in relation with the WebSocket drafts.
- org.java_websocket.enums - package org.java_websocket.enums
-
This package encapsulates all enums.
- org.java_websocket.exceptions - package org.java_websocket.exceptions
-
This package encapsulates all implementations in relation with the exceptions thrown in this lib.
- org.java_websocket.extensions - package org.java_websocket.extensions
-
This package encapsulates all interfaces and implementations in relation with the WebSocket Sec-WebSocket-Extensions.
- org.java_websocket.extensions.permessage_deflate - package org.java_websocket.extensions.permessage_deflate
- org.java_websocket.framing - package org.java_websocket.framing
-
This package encapsulates all interfaces and implementations in relation with the WebSocket frames.
- org.java_websocket.handshake - package org.java_websocket.handshake
-
This package encapsulates all interfaces and implementations in relation with the WebSocket handshake.
- org.java_websocket.interfaces - package org.java_websocket.interfaces
-
This package encapsulates all new interfaces.
- org.java_websocket.protocols - package org.java_websocket.protocols
-
This package encapsulates all interfaces and implementations in relation with the WebSocket Sec-WebSocket-Protocol.
- org.java_websocket.server - package org.java_websocket.server
-
This package encapsulates all implementations in relation with the WebSocketServer.
- org.java_websocket.util - package org.java_websocket.util
-
This package encapsulates the utility classes.
- outCrypt - Variable in class org.java_websocket.SSLSocketChannel2
-
encrypted data outgoing
- OutputStream(OutputStream) - Constructor for class org.java_websocket.util.Base64.OutputStream
-
Constructs a
Base64.OutputStream
in ENCODE mode. - OutputStream(OutputStream, int) - Constructor for class org.java_websocket.util.Base64.OutputStream
-
Constructs a
Base64.OutputStream
in either ENCODE or DECODE mode. - outQueue - Variable in class org.java_websocket.WebSocketImpl
-
Queue of buffers that need to be sent to the client.
P
- parseExtensionRequest(String) - Static method in class org.java_websocket.extensions.ExtensionRequestData
- PerMessageDeflateExtension - Class in org.java_websocket.extensions.permessage_deflate
-
PerMessage Deflate Extension (7. The "permessage-deflate" Extension in RFC 7692).
- PerMessageDeflateExtension() - Constructor for class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- PING - Enum constant in enum class org.java_websocket.enums.Opcode
- PingFrame - Class in org.java_websocket.framing
-
Class to represent a ping frame
- PingFrame() - Constructor for class org.java_websocket.framing.PingFrame
-
constructor which sets the opcode of this frame to ping
- POLICY_VALIDATION - Static variable in class org.java_websocket.framing.CloseFrame
-
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
- PONG - Enum constant in enum class org.java_websocket.enums.Opcode
- PongFrame - Class in org.java_websocket.framing
-
Class to represent a pong frame
- PongFrame() - Constructor for class org.java_websocket.framing.PongFrame
-
constructor which sets the opcode of this frame to pong
- PongFrame(PingFrame) - Constructor for class org.java_websocket.framing.PongFrame
-
constructor which sets the opcode of this frame to ping copying over the payload of the ping
- postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_6455
- postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft
- postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_6455
- postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft
- processFrame(WebSocketImpl, Framedata) - Method in class org.java_websocket.drafts.Draft_6455
- processFrame(WebSocketImpl, Framedata) - Method in class org.java_websocket.drafts.Draft
-
Handle the frame specific to the draft
- Protocol - Class in org.java_websocket.protocols
-
Class which represents the protocol used as Sec-WebSocket-Protocol
- Protocol(String) - Constructor for class org.java_websocket.protocols.Protocol
-
Constructor for a Sec-Websocket-Protocol
- PROTOCOL_ERROR - Static variable in class org.java_websocket.framing.CloseFrame
-
1002 indicates that an endpoint is terminating the connection due to a protocol error.
- put(String, String) - Method in interface org.java_websocket.handshake.HandshakeBuilder
-
Adding a specific field with a specific value
- put(String, String) - Method in class org.java_websocket.handshake.HandshakedataImpl1
- put(WebSocketImpl) - Method in class org.java_websocket.server.WebSocketServer.WebSocketWorker
Q
- queue(WebSocketImpl) - Method in class org.java_websocket.server.WebSocketServer
R
- read(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- read(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel
- read(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel2
-
Blocks when in blocking mode until at least one byte has been decoded.
When not in blocking mode 0 may be returned. - read(ByteBuffer, WebSocketImpl, ByteChannel) - Static method in class org.java_websocket.SocketChannelIOHelper
- readEngineResult - Variable in class org.java_websocket.SSLSocketChannel2
- readLine(ByteBuffer) - Static method in class org.java_websocket.drafts.Draft
- readMore(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- readMore(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel
- readMore(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel2
- readMore(ByteBuffer) - Method in interface org.java_websocket.WrappedByteChannel
-
This function does not read data from the underlying channel at all.
- readMore(ByteBuffer, WebSocketImpl, WrappedByteChannel) - Static method in class org.java_websocket.SocketChannelIOHelper
- readStringLine(ByteBuffer) - Static method in class org.java_websocket.drafts.Draft
- ReadyState - Enum Class in org.java_websocket.enums
-
Enum which represents the state a websocket may be in
- reconnect() - Method in class org.java_websocket.client.WebSocketClient
-
Reinitiates the websocket connection.
- reconnectBlocking() - Method in class org.java_websocket.client.WebSocketClient
-
Same as
reconnect
but blocks until the websocket reconnected or failed to do so. - REFUSE - Static variable in class org.java_websocket.framing.CloseFrame
-
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).
- releaseBuffers(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
- removeConnection(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
-
This method performs remove operations on the connection and therefore also gives control over whether the operation shall be synchronized
- removeHeader(String) - Method in class org.java_websocket.client.WebSocketClient
- reset() - Method in class org.java_websocket.drafts.Draft_6455
- reset() - Method in class org.java_websocket.drafts.Draft
- reset() - Method in class org.java_websocket.extensions.DefaultExtension
- reset() - Method in interface org.java_websocket.extensions.IExtension
-
Cleaning up internal stats when the draft gets reset.
- resolve(URI) - Method in interface org.java_websocket.client.DnsResolver
-
Resolves the IP address for the given URI.
- role - Variable in class org.java_websocket.drafts.Draft
-
In some cases the handshake will be parsed different depending on whether
- Role - Enum Class in org.java_websocket.enums
-
Enum which represents the states a websocket may be in
- run() - Method in class org.java_websocket.client.WebSocketClient
- run() - Method in class org.java_websocket.server.WebSocketServer
- run() - Method in class org.java_websocket.server.WebSocketServer.WebSocketWorker
S
- selectionKey - Variable in class org.java_websocket.SSLSocketChannel2
-
used to set interestOP SelectionKey.OP_WRITE for the underlying channel
- send(byte[]) - Method in class org.java_websocket.client.WebSocketClient
-
Sends binary data to the connected webSocket server.
- send(byte[]) - Method in interface org.java_websocket.WebSocket
-
Send Binary data (plain bytes) to the other end.
- send(byte[]) - Method in class org.java_websocket.WebSocketImpl
- send(String) - Method in class org.java_websocket.client.WebSocketClient
-
Sends text to the connected websocket server.
- send(String) - Method in interface org.java_websocket.WebSocket
-
Send Text data to the other end.
- send(String) - Method in class org.java_websocket.WebSocketImpl
-
Send Text data to the other end.
- send(ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
- send(ByteBuffer) - Method in interface org.java_websocket.WebSocket
-
Send Binary data (plain bytes) to the other end.
- send(ByteBuffer) - Method in class org.java_websocket.WebSocketImpl
-
Send Binary data (plain bytes) to the other end.
- sendFragmentedFrame(Opcode, ByteBuffer, boolean) - Method in class org.java_websocket.client.WebSocketClient
- sendFragmentedFrame(Opcode, ByteBuffer, boolean) - Method in interface org.java_websocket.WebSocket
-
Allows to send continuous/fragmented frames conveniently.
- sendFragmentedFrame(Opcode, ByteBuffer, boolean) - Method in class org.java_websocket.WebSocketImpl
- sendFrame(Collection<Framedata>) - Method in class org.java_websocket.client.WebSocketClient
- sendFrame(Collection<Framedata>) - Method in interface org.java_websocket.WebSocket
-
Send a collection of frames to the other end
- sendFrame(Collection<Framedata>) - Method in class org.java_websocket.WebSocketImpl
- sendFrame(Framedata) - Method in class org.java_websocket.client.WebSocketClient
- sendFrame(Framedata) - Method in interface org.java_websocket.WebSocket
-
Send a frame to the other end
- sendFrame(Framedata) - Method in class org.java_websocket.WebSocketImpl
- sendPing() - Method in class org.java_websocket.client.WebSocketClient
- sendPing() - Method in interface org.java_websocket.WebSocket
-
Send a ping to the other end
- sendPing() - Method in class org.java_websocket.WebSocketImpl
- SERVER - Enum constant in enum class org.java_websocket.enums.Role
- ServerHandshake - Interface in org.java_websocket.handshake
-
Interface for the server handshake
- ServerHandshakeBuilder - Interface in org.java_websocket.handshake
-
The interface for building a handshake for the server
- SERVICE_RESTART - Static variable in class org.java_websocket.framing.CloseFrame
-
1012 indicates that the service is restarted.
- setAttachment(T) - Method in class org.java_websocket.client.WebSocketClient
- setAttachment(T) - Method in interface org.java_websocket.WebSocket
-
Setter for an attachment on the socket connection.
- setAttachment(T) - Method in class org.java_websocket.WebSocketImpl
- setChannel(ByteChannel) - Method in class org.java_websocket.WebSocketImpl
- setClientNoContextTakeover(boolean) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Setter for the "client_no_context_takeover" extension parameter
- setCode(int) - Method in class org.java_websocket.framing.CloseFrame
-
Set the close code for this close frame
- setConnectionLostTimeout(int) - Method in class org.java_websocket.AbstractWebSocket
-
Setter for the interval checking for lost connections A value lower or equal 0 results in the check to be deactivated
- setContent(byte[]) - Method in interface org.java_websocket.handshake.HandshakeBuilder
-
Setter for the content of the handshake
- setContent(byte[]) - Method in class org.java_websocket.handshake.HandshakedataImpl1
- setDaemon(boolean) - Method in class org.java_websocket.AbstractWebSocket
-
Setter for daemon
- setDaemon(boolean) - Method in class org.java_websocket.server.WebSocketServer
- setDeflater(Deflater) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- setDnsResolver(DnsResolver) - Method in class org.java_websocket.client.WebSocketClient
-
Sets a custom DNS resolver.
- setFin(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the fin of this frame to the provided boolean
- setHttpStatus(short) - Method in class org.java_websocket.handshake.HandshakeImpl1Server
- setHttpStatus(short) - Method in interface org.java_websocket.handshake.ServerHandshakeBuilder
-
Setter for the http status code
- setHttpStatusMessage(String) - Method in class org.java_websocket.handshake.HandshakeImpl1Server
- setHttpStatusMessage(String) - Method in interface org.java_websocket.handshake.ServerHandshakeBuilder
-
Setter for the http status message
- setInflater(Inflater) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- setMaxPendingConnections(int) - Method in class org.java_websocket.server.WebSocketServer
-
Set the requested maximum number of pending connections on the socket.
- setParseMode(Role) - Method in class org.java_websocket.drafts.Draft
- setPayload(ByteBuffer) - Method in class org.java_websocket.framing.CloseFrame
- setPayload(ByteBuffer) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the payload of this frame to the provided payload
- setProxy(Proxy) - Method in class org.java_websocket.client.WebSocketClient
-
Method to set a proxy for this connection
- setReason(String) - Method in class org.java_websocket.framing.CloseFrame
-
Set the close reason for this close frame
- setReceiveBufferSize(int) - Method in class org.java_websocket.AbstractWebSocket
-
Sets the TCP receive buffer size that will be used for sockets.
- setResourceDescriptor(String) - Method in interface org.java_websocket.handshake.ClientHandshakeBuilder
-
Set a specific resource descriptor
- setResourceDescriptor(String) - Method in class org.java_websocket.handshake.HandshakeImpl1Client
- setReuseAddr(boolean) - Method in class org.java_websocket.AbstractWebSocket
-
Setter for soReuseAddr
- setRSV1(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the rsv1 of this frame to the provided boolean
- setRSV2(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the rsv2 of this frame to the provided boolean
- setRSV3(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the rsv3 of this frame to the provided boolean
- setSelectionKey(SelectionKey) - Method in class org.java_websocket.WebSocketImpl
- setServerNoContextTakeover(boolean) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Setter for the "server_no_context_takeover" extension parameter
- setSocket(Socket) - Method in class org.java_websocket.client.WebSocketClient
-
Deprecated.use setSocketFactory
- setSocketFactory(SocketFactory) - Method in class org.java_websocket.client.WebSocketClient
-
Accepts a SocketFactory.
This method must be called beforeconnect
. - setTcpNoDelay(boolean) - Method in class org.java_websocket.AbstractWebSocket
-
Setter for tcpNoDelay
- setThreshold(int) - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
-
Set the size when payloads smaller than this will not be compressed.
- setTransferemasked(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
-
Set the tranferemask of this frame to the provided boolean
- setWebSocketFactory(WebSocketServerFactory) - Method in class org.java_websocket.server.WebSocketServer
- setWorkerThread(WebSocketServer.WebSocketWorker) - Method in class org.java_websocket.WebSocketImpl
- socket() - Method in class org.java_websocket.SSLSocketChannel2
- socketChannel - Variable in class org.java_websocket.SSLSocketChannel2
-
the underlying channel
- SocketChannelIOHelper - Class in org.java_websocket
- sslcontext - Variable in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- sslEngine - Variable in class org.java_websocket.SSLSocketChannel2
- SSLParametersWebSocketServerFactory - Class in org.java_websocket.server
-
WebSocketFactory that can be configured to only support specific protocols and cipher suites.
- SSLParametersWebSocketServerFactory(SSLContext, ExecutorService, SSLParameters) - Constructor for class org.java_websocket.server.SSLParametersWebSocketServerFactory
-
New CustomSSLWebSocketServerFactory configured to only support given protocols and given cipher suites.
- SSLParametersWebSocketServerFactory(SSLContext, SSLParameters) - Constructor for class org.java_websocket.server.SSLParametersWebSocketServerFactory
-
New CustomSSLWebSocketServerFactory configured to only support given protocols and given cipher suites.
- SSLSocketChannel - Class in org.java_websocket
-
A class that represents an SSL/TLS peer, and can be extended to create a client or a server.
- SSLSocketChannel(SocketChannel, SSLEngine, ExecutorService, SelectionKey) - Constructor for class org.java_websocket.SSLSocketChannel
- SSLSocketChannel2 - Class in org.java_websocket
-
Implements the relevant portions of the SocketChannel interface with the SSLEngine wrapper.
- SSLSocketChannel2(SocketChannel, SSLEngine, ExecutorService, SelectionKey) - Constructor for class org.java_websocket.SSLSocketChannel2
- start() - Method in class org.java_websocket.server.WebSocketServer
-
Starts the server selectorthread that binds to the currently set port number and listeners for WebSocket connection requests.
- startConnectionLostTimer() - Method in class org.java_websocket.AbstractWebSocket
-
Start the connection lost timer
- startHandshake(ClientHandshakeBuilder) - Method in class org.java_websocket.WebSocketImpl
- stop() - Method in class org.java_websocket.server.WebSocketServer
- stop(int) - Method in class org.java_websocket.server.WebSocketServer
- stop(int, String) - Method in class org.java_websocket.server.WebSocketServer
-
Closes all connected clients sockets, then closes the underlying ServerSocketChannel, effectively killing the server socket selectorthread, freeing the port the server was bound to and stops all internal workerthreads.
- stopConnectionLostTimer() - Method in class org.java_websocket.AbstractWebSocket
-
Stop the connection lost timer
- stringAscii(byte[]) - Static method in class org.java_websocket.util.Charsetfunctions
- stringAscii(byte[], int, int) - Static method in class org.java_websocket.util.Charsetfunctions
- stringUtf8(byte[]) - Static method in class org.java_websocket.util.Charsetfunctions
- stringUtf8(ByteBuffer) - Static method in class org.java_websocket.util.Charsetfunctions
T
- tasks - Variable in class org.java_websocket.SSLSocketChannel2
- TEXT - Enum constant in enum class org.java_websocket.enums.Opcode
- TextFrame - Class in org.java_websocket.framing
-
Class to represent a text frames
- TextFrame() - Constructor for class org.java_websocket.framing.TextFrame
-
constructor which sets the opcode of this frame to text
- TLS_ERROR - Static variable in class org.java_websocket.framing.CloseFrame
-
1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- TOOBIG - Static variable in class org.java_websocket.framing.CloseFrame
-
1009 indicates that an endpoint is terminating the connection because it has received a message which is too big for it to process.
- toString() - Method in class org.java_websocket.drafts.Draft_6455
- toString() - Method in class org.java_websocket.drafts.Draft
- toString() - Method in class org.java_websocket.extensions.DefaultExtension
- toString() - Method in interface org.java_websocket.extensions.IExtension
-
Return a string which should contain the class name as well as additional information about the current configurations for this extension (DEBUG purposes)
- toString() - Method in class org.java_websocket.extensions.permessage_deflate.PerMessageDeflateExtension
- toString() - Method in class org.java_websocket.framing.CloseFrame
- toString() - Method in class org.java_websocket.framing.FramedataImpl1
- toString() - Method in interface org.java_websocket.protocols.IProtocol
-
Return a string which should contain the protocol name as well as additional information about the current configurations for this protocol (DEBUG purposes)
- toString() - Method in class org.java_websocket.protocols.Protocol
- toString() - Method in class org.java_websocket.WebSocketImpl
- transferByteBuffer(ByteBuffer, ByteBuffer) - Static method in class org.java_websocket.util.ByteBufferUtils
-
Transfer from one ByteBuffer to another ByteBuffer
- translateFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_6455
- translateFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft
- translateHandshake(ByteBuffer) - Method in class org.java_websocket.drafts.Draft
- translateHandshakeHttp(ByteBuffer, Role) - Static method in class org.java_websocket.drafts.Draft
- TRY_AGAIN_LATER - Static variable in class org.java_websocket.framing.CloseFrame
-
1013 indicates that the service is experiencing overload.
- TWOWAY - Enum constant in enum class org.java_websocket.enums.CloseHandshakeType
U
- UNEXPECTED_CONDITION - Static variable in class org.java_websocket.framing.CloseFrame
-
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
- updateLastPong() - Method in class org.java_websocket.WebSocketImpl
-
Update the timestamp when the last pong was received
- uri - Variable in class org.java_websocket.client.WebSocketClient
-
The URI this channel is supposed to connect to.
- URL_SAFE - Static variable in class org.java_websocket.util.Base64
-
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.
- utf8Bytes(String) - Static method in class org.java_websocket.util.Charsetfunctions
V
- valueOf(String) - Static method in enum class org.java_websocket.enums.CloseHandshakeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.java_websocket.enums.HandshakeState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.java_websocket.enums.Opcode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.java_websocket.enums.ReadyState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.java_websocket.enums.Role
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.java_websocket.enums.CloseHandshakeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.java_websocket.enums.HandshakeState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.java_websocket.enums.Opcode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.java_websocket.enums.ReadyState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.java_websocket.enums.Role
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WebSocket - Interface in org.java_websocket
- WebSocketAdapter - Class in org.java_websocket
-
This class default implements all methods of the WebSocketListener that can be overridden optionally when advances functionalities is needed.
- WebSocketAdapter() - Constructor for class org.java_websocket.WebSocketAdapter
- WebSocketClient - Class in org.java_websocket.client
-
A subclass must implement at least onOpen, onClose, and onMessage to be useful.
- WebSocketClient(URI) - Constructor for class org.java_websocket.client.WebSocketClient
-
Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
- WebSocketClient(URI, Map<String, String>) - Constructor for class org.java_websocket.client.WebSocketClient
-
Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
- WebSocketClient(URI, Draft) - Constructor for class org.java_websocket.client.WebSocketClient
-
Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
- WebSocketClient(URI, Draft, Map<String, String>) - Constructor for class org.java_websocket.client.WebSocketClient
-
Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
- WebSocketClient(URI, Draft, Map<String, String>, int) - Constructor for class org.java_websocket.client.WebSocketClient
-
Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
- WebSocketFactory - Interface in org.java_websocket
- WebSocketImpl - Class in org.java_websocket
-
Represents one end (client or server) of a single WebSocketImpl connection.
- WebSocketImpl(WebSocketListener, List<Draft>) - Constructor for class org.java_websocket.WebSocketImpl
-
Creates a websocket with server role
- WebSocketImpl(WebSocketListener, Draft) - Constructor for class org.java_websocket.WebSocketImpl
-
creates a websocket with client role
- WebSocketListener - Interface in org.java_websocket
-
Implemented by
WebSocketClient
andWebSocketServer
. - WebsocketNotConnectedException - Exception Class in org.java_websocket.exceptions
-
exception which indicates the websocket is not yet connected (ReadyState.OPEN)
- WebsocketNotConnectedException() - Constructor for exception class org.java_websocket.exceptions.WebsocketNotConnectedException
- WebSocketServer - Class in org.java_websocket.server
-
WebSocketServer
is an abstract class that only takes care of the HTTP handshake portion of WebSockets. - WebSocketServer() - Constructor for class org.java_websocket.server.WebSocketServer
-
Creates a WebSocketServer that will attempt to listen on port WebSocketImpl.DEFAULT_PORT.
- WebSocketServer(InetSocketAddress) - Constructor for class org.java_websocket.server.WebSocketServer
-
Creates a WebSocketServer that will attempt to bind/listen on the given address.
- WebSocketServer(InetSocketAddress, int) - Constructor for class org.java_websocket.server.WebSocketServer
- WebSocketServer(InetSocketAddress, int, List<Draft>) - Constructor for class org.java_websocket.server.WebSocketServer
- WebSocketServer(InetSocketAddress, int, List<Draft>, Collection<WebSocket>) - Constructor for class org.java_websocket.server.WebSocketServer
-
Creates a WebSocketServer that will attempt to bind/listen on the given address, and comply with
Draft
version draft. - WebSocketServer(InetSocketAddress, List<Draft>) - Constructor for class org.java_websocket.server.WebSocketServer
- WebSocketServer.WebSocketWorker - Class in org.java_websocket.server
-
This class is used to process incoming data
- WebSocketServerFactory - Interface in org.java_websocket
-
Interface to encapsulate the required methods for a websocket factory
- WebSocketWorker() - Constructor for class org.java_websocket.server.WebSocketServer.WebSocketWorker
- wrapChannel(SocketChannel, SelectionKey) - Method in class org.java_websocket.server.CustomSSLWebSocketServerFactory
- wrapChannel(SocketChannel, SelectionKey) - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
- wrapChannel(SocketChannel, SelectionKey) - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
- wrapChannel(SocketChannel, SelectionKey) - Method in class org.java_websocket.server.SSLParametersWebSocketServerFactory
- wrapChannel(SocketChannel, SelectionKey) - Method in interface org.java_websocket.WebSocketServerFactory
-
Allows to wrap the SocketChannel( key.channel() ) to insert a protocol layer( like ssl or proxy authentication) beyond the ws layer.
- WrappedByteChannel - Interface in org.java_websocket
- WrappedIOException - Exception Class in org.java_websocket.exceptions
-
Exception to wrap an IOException and include information about the websocket which had the exception
- WrappedIOException(WebSocket, IOException) - Constructor for exception class org.java_websocket.exceptions.WrappedIOException
-
Wrapp an IOException and include the websocket
- write(byte[], int, int) - Method in class org.java_websocket.util.Base64.OutputStream
-
Calls
Base64.OutputStream.write(int)
repeatedly until len bytes are written. - write(int) - Method in class org.java_websocket.util.Base64.OutputStream
-
Writes the byte to the output stream after converting to/from Base64 notation.
- write(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- write(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel
- write(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel2
- writeEngineResult - Variable in class org.java_websocket.SSLSocketChannel2
- writeMore() - Method in class org.java_websocket.AbstractWrappedByteChannel
-
Deprecated.
- writeMore() - Method in class org.java_websocket.SSLSocketChannel
- writeMore() - Method in class org.java_websocket.SSLSocketChannel2
- writeMore() - Method in interface org.java_websocket.WrappedByteChannel
-
Gets called when
isNeedWrite()
()} requires a additional rite
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form