Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W 

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.
AbstractClientProxyChannel - Class in org.java_websocket.client
 
AbstractClientProxyChannel(ByteChannel) - Constructor for class org.java_websocket.client.AbstractClientProxyChannel
 
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
 
AbstractWrappedByteChannel(ByteChannel) - Constructor for class org.java_websocket.AbstractWrappedByteChannel
 
AbstractWrappedByteChannel(WrappedByteChannel) - Constructor for class org.java_websocket.AbstractWrappedByteChannel
 
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft
 
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft
 
acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft_17
Deprecated.
 
acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
acceptHandshakeAsServer(ClientHandshake) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
addConnection(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
 
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 This methods does not override the opcode, but does override the fin
append(Framedata) - Method in class org.java_websocket.framing.FramedataImpl1
 
asciiBytes(String) - Static method in class org.java_websocket.util.Charsetfunctions
 

B

Base64 - Class in org.java_websocket.util
Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in org.java_websocket.util
A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream - Class in org.java_websocket.util
A Base64.OutputStream will write data to another java.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
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
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)
buildHandShake() - Method in class org.java_websocket.client.AbstractClientProxyChannel
 
ByteBufferUtils - Class in org.java_websocket.util
Utility class for ByteBuffers

C

channel - Variable in class org.java_websocket.WebSocketImpl
the possibly wrapped channel object whose selection is controlled by WebSocketImpl.key
Charsetfunctions - Class in org.java_websocket.util
 
checkAlloc(int) - Method in class org.java_websocket.drafts.Draft
 
ClientHandshake - Interface in org.java_websocket.handshake
 
ClientHandshakeBuilder - Interface in org.java_websocket.handshake
 
close() - Method in class org.java_websocket.AbstractWrappedByteChannel
 
close() - Method in class org.java_websocket.client.WebSocketClient
Initiates the websocket close handshake.
close(int) - Method in class org.java_websocket.client.WebSocketClient
 
close(int, String) - Method in class org.java_websocket.client.WebSocketClient
 
close() - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
 
close() - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
 
close() - Method in interface org.java_websocket.server.WebSocketServer.WebSocketServerFactory
Allows to shutdown the websocket factory for a clean shutdown
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(int, String) - Method in interface org.java_websocket.WebSocket
sends the closing handshake.
close(int) - Method in interface org.java_websocket.WebSocket
sends the closing handshake.
close() - Method in interface org.java_websocket.WebSocket
Convenience function which behaves like close(CloseFrame.NORMAL)
close(int, String) - Method in class org.java_websocket.WebSocketImpl
 
close(int) - Method in class org.java_websocket.WebSocketImpl
 
close(InvalidDataException) - Method in class org.java_websocket.WebSocketImpl
 
close() - 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(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, boolean) - Method in class org.java_websocket.WebSocketImpl
This will close the connection immediately without a proper close handshake.
closeConnection(int, boolean) - Method in class org.java_websocket.WebSocketImpl
 
closeConnection() - Method in class org.java_websocket.WebSocketImpl
 
closeConnection(int, String) - Method in class org.java_websocket.WebSocketImpl
 
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 Using opcode closing and fin = true
codingErrorAction - Static variable in class org.java_websocket.util.Charsetfunctions
 
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.
connections() - Method in class org.java_websocket.AbstractWebSocket
Getter to get all the currently available connections
connections() - Method in class org.java_websocket.client.WebSocketClient
 
connections() - Method in class org.java_websocket.server.WebSocketServer
Returns a WebSocket[] of currently connected clients.
consumeDelegatedTasks() - Method in class org.java_websocket.SSLSocketChannel2
 
continuousFrame(Framedata.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
Absstract class to represent control frames
ControlFrame(Framedata.Opcode) - Constructor for class org.java_websocket.framing.ControlFrame
Class to represent a control frame
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.drafts.Draft_10
Deprecated.
 
copyInstance() - Method in class org.java_websocket.drafts.Draft_17
Deprecated.
 
copyInstance() - Method in class org.java_websocket.drafts.Draft_6455
 
copyInstance() - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
copyInstance() - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
CR - Static variable in class org.java_websocket.drafts.Draft_75
Deprecated.
The byte representing CR, or Carriage Return, or \r
createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft
 
createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
createBinaryFrame(Framedata) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
createBuffer() - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
createBuffer() - Method in class org.java_websocket.server.WebSocketServer
 
createBuffers(SSLSession) - Method in class org.java_websocket.SSLSocketChannel2
 
createChallenge(String, String, byte[]) - Static method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
createFrames(ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft
 
createFrames(String, boolean) - Method in class org.java_websocket.drafts.Draft
 
createFrames(ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
createFrames(String, boolean) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
createFrames(ByteBuffer, boolean) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
createFrames(String, boolean) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
createHandshake(Handshakedata, WebSocket.Role) - Method in class org.java_websocket.drafts.Draft
 
createHandshake(Handshakedata, WebSocket.Role, boolean) - Method in class org.java_websocket.drafts.Draft
 
createWebSocket(WebSocketAdapter, Draft) - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
 
createWebSocket(WebSocketAdapter, List<Draft>) - Method in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
 
createWebSocket(WebSocketAdapter, Draft) - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
 
createWebSocket(WebSocketAdapter, List<Draft>) - Method in class org.java_websocket.server.DefaultWebSocketServerFactory
 
createWebSocket(WebSocketAdapter, Draft) - Method in interface org.java_websocket.server.WebSocketServer.WebSocketServerFactory
 
createWebSocket(WebSocketAdapter, List<Draft>) - Method in interface org.java_websocket.server.WebSocketServer.WebSocketServerFactory
 
createWebSocket(WebSocketAdapter, 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.WebSocketFactory
Create a new Websocket with the provided listener, drafts and socket
currentFrame - Variable in class org.java_websocket.drafts.Draft_75
Deprecated.
 
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
Absstract class to represent data frames
DataFrame(Framedata.Opcode) - Constructor for class org.java_websocket.framing.DataFrame
Class to represent a data frame
DEBUG - Static variable in class org.java_websocket.WebSocketImpl
Activate debug mode for additional infos
DECODE - Static variable in class org.java_websocket.util.Base64
Specify decoding in first bit.
decode(byte[]) - Static method in class org.java_websocket.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array.
decode(byte[], int, int, int) - Static method in class org.java_websocket.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array.
decode(String) - Static method in class org.java_websocket.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
decode(String, int) - Static method in class org.java_websocket.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
decode(ByteBuffer) - Method in class org.java_websocket.WebSocketImpl
Method to decode the provided ByteBuffer
decodeFileToFile(String, String) - Static method in class org.java_websocket.util.Base64
Reads infile and decodes it to outfile.
decodeFromFile(String) - Static method in class org.java_websocket.util.Base64
Convenience method for reading a base64-encoded file and decoding it.
DECODERS - Static variable in class org.java_websocket.server.WebSocketServer
 
decoders - Variable in class org.java_websocket.server.WebSocketServer
 
decodeToFile(String, String) - Static method in class org.java_websocket.util.Base64
Convenience method for decoding data to a file.
decodeToObject(String) - Static method in class org.java_websocket.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within.
decodeToObject(String, int, ClassLoader) - Static method in class org.java_websocket.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within.
DEFAULT_PORT - Static variable in interface org.java_websocket.WebSocket
The default port of WebSockets, as defined in the spec.
DEFAULT_WSS_PORT - Static variable in interface org.java_websocket.WebSocket
The default wss port of WebSockets, as defined in the spec.
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
 
DO_BREAK_LINES - Static variable in class org.java_websocket.util.Base64
Do break lines when encoding.
DONT_GUNZIP - Static variable in class org.java_websocket.util.Base64
Specify that gzipped data should not be automatically gunzipped.
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 transfered.
Draft() - Constructor for class org.java_websocket.drafts.Draft
 
Draft.CloseHandshakeType - Enum in org.java_websocket.drafts
Enum which represents type of handshake is required for a close
Draft.HandshakeState - Enum in org.java_websocket.drafts
Enum which represents the states a handshake may be in
Draft_10 - Class in org.java_websocket.drafts
Deprecated.
Draft_10() - Constructor for class org.java_websocket.drafts.Draft_10
Deprecated.
 
Draft_17 - Class in org.java_websocket.drafts
Deprecated.
Draft_17() - Constructor for class org.java_websocket.drafts.Draft_17
Deprecated.
 
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
 
Draft_75 - Class in org.java_websocket.drafts
Deprecated.
Draft_75() - Constructor for class org.java_websocket.drafts.Draft_75
Deprecated.
 
Draft_76 - Class in org.java_websocket.drafts
Deprecated.
Draft_76() - Constructor for class org.java_websocket.drafts.Draft_76
Deprecated.
 

E

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.
encode(ByteBuffer, ByteBuffer) - Static method in class org.java_websocket.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer.
encode(ByteBuffer, CharBuffer) - Static method in class org.java_websocket.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer.
encodeBytes(byte[]) - Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation.
encodeBytes(byte[], int) - Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation.
encodeBytes(byte[], int, int) - 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[]) - Static method in class org.java_websocket.util.Base64
Similar to Base64.encodeBytes(byte[]) but returns a byte array instead of instantiating a String.
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.
encodeFileToFile(String, String) - Static method in class org.java_websocket.util.Base64
Reads infile and encodes it to outfile.
encodeFromFile(String) - Static method in class org.java_websocket.util.Base64
Convenience method for reading a binary file and base64-encoding it.
encodeObject(Serializable) - Static method in class org.java_websocket.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object.
encodeObject(Serializable, int) - Static method in class org.java_websocket.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object.
encodeToFile(byte[], String) - Static method in class org.java_websocket.util.Base64
Convenience method for encoding data to a file.
END_OF_FRAME - Static variable in class org.java_websocket.drafts.Draft_75
Deprecated.
The byte representing the end of a WebSocket text frame.
eot() - Method in class org.java_websocket.WebSocketImpl
 
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.

F

finishConnect() - Method in class org.java_websocket.SSLSocketChannel2
 
FLASH_POLICY_REQUEST - Static variable in class org.java_websocket.drafts.Draft
 
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
 
Framedata.Opcode - Enum in org.java_websocket.framing
Enum which contains the different valid opcodes
FramedataImpl1 - Class in org.java_websocket.framing
 
FramedataImpl1(Framedata.Opcode) - Constructor for class org.java_websocket.framing.FramedataImpl1
Constructor for a FramedataImpl without any attributes set apart from the opcode

G

get(Framedata.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
 
getCloseCode() - Method in exception 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
 
getCloseHandshakeType() - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
getCloseHandshakeType() - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
getCloseHandshakeType() - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
getConnection() - Method in class org.java_websocket.client.WebSocketClient
Getter for the engine
getConnectionLostTimeout() - Method in class org.java_websocket.AbstractWebSocket
Get the interval checking for lost connections Default is 60 seconds
getContent() - Method in interface org.java_websocket.handshake.Handshakedata
 
getContent() - Method in class org.java_websocket.handshake.HandshakedataImpl1
 
getDraft() - Method in class org.java_websocket.client.WebSocketClient
Returns the protocol version this channel uses.
getDraft() - Method in class org.java_websocket.server.WebSocketServer
 
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
getFieldValue(String) - Method in interface org.java_websocket.handshake.Handshakedata
 
getFieldValue(String) - Method in class org.java_websocket.handshake.HandshakedataImpl1
 
getFlashPolicy(WebSocket) - Method in class org.java_websocket.WebSocketAdapter
Gets the XML string that should be returned if a client requests a Flash security policy.
getFlashPolicy(WebSocket) - Method in interface org.java_websocket.WebSocketListener
 
getHttpStatus() - Method in class org.java_websocket.handshake.HandshakeImpl1Server
 
getHttpStatus() - Method in interface org.java_websocket.handshake.ServerHandshake
 
getHttpStatusMessage() - Method in class org.java_websocket.handshake.HandshakeImpl1Server
 
getHttpStatusMessage() - Method in interface org.java_websocket.handshake.ServerHandshake
 
getLocalSocketAddress(WebSocket) - Method in class org.java_websocket.client.WebSocketClient
 
getLocalSocketAddress() - Method in class org.java_websocket.client.WebSocketClient
 
getLocalSocketAddress(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
 
getLocalSocketAddress() - Method in interface org.java_websocket.WebSocket
Returns the address of the endpoint this socket is bound to.
getLocalSocketAddress() - Method in class org.java_websocket.WebSocketImpl
 
getLocalSocketAddress(WebSocket) - Method in interface org.java_websocket.WebSocketListener
 
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.
getPreferedSize() - Method in exception org.java_websocket.exceptions.IncompleteHandshakeException
Getter preferedSize
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
 
getRemoteSocketAddress(WebSocket) - Method in class org.java_websocket.client.WebSocketClient
 
getRemoteSocketAddress() - Method in class org.java_websocket.client.WebSocketClient
 
getRemoteSocketAddress(WebSocket) - Method in class org.java_websocket.server.WebSocketServer
 
getRemoteSocketAddress() - Method in interface org.java_websocket.WebSocket
Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.
getRemoteSocketAddress() - Method in class org.java_websocket.WebSocketImpl
 
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
 
getSocket() - Method in class org.java_websocket.client.WebSocketClient
Returns the socket to allow Hostname Verification
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
 
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
 
Handshakedata - Interface in org.java_websocket.handshake
 
HandshakedataImpl1 - Class in org.java_websocket.handshake
 
HandshakedataImpl1() - Constructor for class org.java_websocket.handshake.HandshakedataImpl1
 
HandshakeImpl1Client - Class in org.java_websocket.handshake
 
HandshakeImpl1Client() - Constructor for class org.java_websocket.handshake.HandshakeImpl1Client
 
HandshakeImpl1Server - Class in org.java_websocket.handshake
 
HandshakeImpl1Server() - Constructor for class org.java_websocket.handshake.HandshakeImpl1Server
 
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
 
hasFieldValue(String) - Method in class org.java_websocket.handshake.HandshakedataImpl1
 
hashCode() - Method in class org.java_websocket.WebSocketImpl
 

I

IncompleteHandshakeException - Exception in org.java_websocket.exceptions
exception which indicates that a incomplete handshake was recieved
IncompleteHandshakeException(int) - Constructor for exception org.java_websocket.exceptions.IncompleteHandshakeException
constructor for a IncompleteHandshakeException
IncompleteHandshakeException() - Constructor for exception org.java_websocket.exceptions.IncompleteHandshakeException
constructor for a IncompleteHandshakeException preferedSize will be 0
increaseBuffer(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
inCrypt - Variable in class org.java_websocket.SSLSocketChannel2
encrypted data incoming
inData - Variable in class org.java_websocket.SSLSocketChannel2
raw payload incomming
INITIAL_FAMESIZE - Static variable in class org.java_websocket.drafts.Draft
 
InputStream(InputStream) - Constructor for class org.java_websocket.util.Base64.InputStream
Constructs a Base64.InputStream in DECODE mode.
InputStream(InputStream, int) - Constructor for class org.java_websocket.util.Base64.InputStream
Constructs a Base64.InputStream in either ENCODE or DECODE mode.
inQueue - Variable in class org.java_websocket.WebSocketImpl
Queue of buffers that need to be processed
InvalidDataException - Exception in org.java_websocket.exceptions
exception which indicates that a invalid data was recieved
InvalidDataException(int) - Constructor for exception org.java_websocket.exceptions.InvalidDataException
constructor for a InvalidDataException
InvalidDataException(int, String) - Constructor for exception org.java_websocket.exceptions.InvalidDataException
constructor for a InvalidDataException.
InvalidDataException(int, Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidDataException
constructor for a InvalidDataException.
InvalidDataException(int, String, Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidDataException
constructor for a InvalidDataException.
InvalidFrameException - Exception in org.java_websocket.exceptions
exception which indicates that a invalid frame was recieved (CloseFrame.PROTOCOL_ERROR)
InvalidFrameException() - Constructor for exception org.java_websocket.exceptions.InvalidFrameException
constructor for a InvalidFrameException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidFrameException(String) - Constructor for exception org.java_websocket.exceptions.InvalidFrameException
constructor for a InvalidFrameException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidFrameException(Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidFrameException
constructor for a InvalidFrameException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidFrameException(String, Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidFrameException
constructor for a InvalidFrameException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidHandshakeException - Exception in org.java_websocket.exceptions
exception which indicates that a invalid handshake was recieved (CloseFrame.PROTOCOL_ERROR)
InvalidHandshakeException() - Constructor for exception org.java_websocket.exceptions.InvalidHandshakeException
constructor for a InvalidHandshakeException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidHandshakeException(String, Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidHandshakeException
constructor for a InvalidHandshakeException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidHandshakeException(String) - Constructor for exception org.java_websocket.exceptions.InvalidHandshakeException
constructor for a InvalidHandshakeException calling InvalidDataException with closecode PROTOCOL_ERROR
InvalidHandshakeException(Throwable) - Constructor for exception org.java_websocket.exceptions.InvalidHandshakeException
constructor for a InvalidHandshakeException calling InvalidDataException with closecode PROTOCOL_ERROR
isBlocking() - Method in class org.java_websocket.AbstractWrappedByteChannel
 
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
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
 
isConnecting() - Method in class org.java_websocket.client.WebSocketClient
 
isConnecting() - Method in interface org.java_websocket.WebSocket
Is the websocket in the state CONNECTING
isConnecting() - Method in class org.java_websocket.WebSocketImpl
 
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
 
isInboundDone() - Method in class org.java_websocket.SSLSocketChannel2
 
isNeedRead() - Method in class org.java_websocket.AbstractWrappedByteChannel
 
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
 
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
 
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
 
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
 
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
isValidUTF8(ByteBuffer, int) - Static method in class org.java_websocket.util.Charsetfunctions
Check if the provided BytebBuffer contains a valid utf8 encoded string.
isValidUTF8(ByteBuffer) - Static method in class org.java_websocket.util.Charsetfunctions
Calling isValidUTF8 with offset 0
iterateHttpFields() - Method in interface org.java_websocket.handshake.Handshakedata
 
iterateHttpFields() - Method in class org.java_websocket.handshake.HandshakedataImpl1
 

K

key - Variable in class org.java_websocket.WebSocketImpl
 

L

LF - Static variable in class org.java_websocket.drafts.Draft_75
Deprecated.
The byte representing LF, or Line Feed, or \n
LimitExedeedException - Exception in org.java_websocket.exceptions
exception which indicates that the message limited was exedeeded (CloseFrame.TOOBIG)
LimitExedeedException() - Constructor for exception org.java_websocket.exceptions.LimitExedeedException
constructor for a LimitExedeedException calling InvalidDataException with closecode TOOBIG
LimitExedeedException(String) - Constructor for exception org.java_websocket.exceptions.LimitExedeedException
constructor for a LimitExedeedException calling InvalidDataException with closecode TOOBIG

M

MAX_FAME_SIZE - Static variable in class org.java_websocket.drafts.Draft
 

N

NEVER_CONNECTED - Static variable in class org.java_websocket.framing.CloseFrame
The connection had never been established
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.
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.
NotSendableException - Exception in org.java_websocket.exceptions
exception which indicates the frame payload is not sendable
NotSendableException() - Constructor for exception org.java_websocket.exceptions.NotSendableException
constructor for a NotSendableException
NotSendableException(String) - Constructor for exception org.java_websocket.exceptions.NotSendableException
constructor for a NotSendableException
NotSendableException(Throwable) - Constructor for exception org.java_websocket.exceptions.NotSendableException
constructor for a NotSendableException
NotSendableException(String, Throwable) - Constructor for exception org.java_websocket.exceptions.NotSendableException
constructor for a NotSendableException

O

onClose(int, String, boolean) - Method in class org.java_websocket.client.WebSocketClient
 
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.
onError(Exception) - Method in class org.java_websocket.client.WebSocketClient
 
onError(WebSocket, Exception) - Method in class org.java_websocket.server.WebSocketServer
Called when errors occurs.
onFragment(Framedata) - Method in class org.java_websocket.client.WebSocketClient
 
onFragment(WebSocket, Framedata) - Method in class org.java_websocket.server.WebSocketServer
Callback for fragmented frames
onMessage(String) - Method in class org.java_websocket.client.WebSocketClient
 
onMessage(ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
 
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
 
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.
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.server.WebSocketServer
 
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, ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
 
onWebsocketMessage(WebSocket, String) - Method in class org.java_websocket.server.WebSocketServer
 
onWebsocketMessage(WebSocket, ByteBuffer) - 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 interface org.java_websocket.WebSocketListener
Called when an entire binary frame has been received.
onWebsocketMessageFragment(WebSocket, Framedata) - Method in class org.java_websocket.client.WebSocketClient
 
onWebsocketMessageFragment(WebSocket, Framedata) - Method in class org.java_websocket.server.WebSocketServer
Deprecated.
onWebsocketMessageFragment(WebSocket, Framedata) - Method in class org.java_websocket.WebSocketAdapter
This default implementation does not do anything.
onWebsocketMessageFragment(WebSocket, Framedata) - Method in interface org.java_websocket.WebSocketListener
Called when a frame fragment has been recieved
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.
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
 
org.java_websocket.drafts - package org.java_websocket.drafts
 
org.java_websocket.exceptions - package org.java_websocket.exceptions
 
org.java_websocket.framing - package org.java_websocket.framing
 
org.java_websocket.handshake - package org.java_websocket.handshake
 
org.java_websocket.server - package org.java_websocket.server
 
org.java_websocket.util - package org.java_websocket.util
 
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

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.
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
 
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_17
Deprecated.
 
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft
 
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_6455
 
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
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.
proxyHandshake - Variable in class org.java_websocket.client.AbstractClientProxyChannel
 
put(String, String) - Method in interface org.java_websocket.handshake.HandshakeBuilder
 
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

RCVBUF - Static variable in class org.java_websocket.WebSocketImpl
 
read(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
 
read(ByteBuffer, WebSocketImpl, ByteChannel) - Static method in class org.java_websocket.SocketChannelIOHelper
 
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.
read() - Method in class org.java_websocket.util.Base64.InputStream
Reads enough of the input stream to convert to/from Base64 and returns the next byte.
read(byte[], int, int) - Method in class org.java_websocket.util.Base64.InputStream
Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read.
readEngineResult - Variable in class org.java_websocket.SSLSocketChannel2
 
readingState - Variable in class org.java_websocket.drafts.Draft_75
Deprecated.
Is only used to detect protocol violations
readLine(ByteBuffer) - Static method in class org.java_websocket.drafts.Draft
 
readMore(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
 
readMore(ByteBuffer, WebSocketImpl, WrappedByteChannel) - Static method in class org.java_websocket.SocketChannelIOHelper
 
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.
readStringLine(ByteBuffer) - Static method in class org.java_websocket.drafts.Draft
 
readVersion(Handshakedata) - Static method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
readyframes - Variable in class org.java_websocket.drafts.Draft_75
Deprecated.
 
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 WebSocketServer.WebSocketServer(InetSocketAddress, int, List, Collection) allows to specify a collection which will be used to store current connections in.
reset() - Method in class org.java_websocket.drafts.Draft
 
reset() - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
reset() - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
resumeEncoding() - Method in class org.java_websocket.util.Base64.OutputStream
Resumes encoding of the stream.
role - Variable in class org.java_websocket.drafts.Draft
In some cases the handshake will be parsed different depending on whether
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(String) - Method in class org.java_websocket.client.WebSocketClient
Sends text to the connected websocket server.
send(byte[]) - Method in class org.java_websocket.client.WebSocketClient
Sends binary data to the connected webSocket server.
send(ByteBuffer) - Method in class org.java_websocket.client.WebSocketClient
 
send(String) - Method in interface org.java_websocket.WebSocket
Send Text data to the other end.
send(ByteBuffer) - Method in interface org.java_websocket.WebSocket
Send Binary data (plain bytes) to the other end.
send(byte[]) - Method in interface org.java_websocket.WebSocket
Send Binary data (plain bytes) 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.WebSocketImpl
Send Binary data (plain bytes) to the other end.
send(byte[]) - Method in class org.java_websocket.WebSocketImpl
 
sendFragmentedFrame(Framedata.Opcode, ByteBuffer, boolean) - Method in class org.java_websocket.client.WebSocketClient
 
sendFragmentedFrame(Framedata.Opcode, ByteBuffer, boolean) - Method in interface org.java_websocket.WebSocket
Allows to send continuous/fragmented frames conveniently.
sendFragmentedFrame(Framedata.Opcode, ByteBuffer, boolean) - 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
 
ServerHandshake - Interface in org.java_websocket.handshake
 
ServerHandshakeBuilder - Interface in org.java_websocket.handshake
 
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
 
setContent(byte[]) - Method in class org.java_websocket.handshake.HandshakedataImpl1
 
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
 
setHttpStatusMessage(String) - Method in class org.java_websocket.handshake.HandshakeImpl1Server
 
setHttpStatusMessage(String) - Method in interface org.java_websocket.handshake.ServerHandshakeBuilder
 
setParseMode(WebSocket.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
 
setReason(String) - Method in class org.java_websocket.framing.CloseFrame
Set the close reason for this close frame
setResourceDescriptor(String) - Method in interface org.java_websocket.handshake.ClientHandshakeBuilder
 
setResourceDescriptor(String) - Method in class org.java_websocket.handshake.HandshakeImpl1Client
 
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
setSocket(Socket) - Method in class org.java_websocket.client.WebSocketClient
Accepts bound and unbound sockets.
setTcpNoDelay(boolean) - Method in class org.java_websocket.AbstractWebSocket
Setter for tcpNoDelay Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm) for new connections
setTransferemasked(boolean) - Method in class org.java_websocket.framing.FramedataImpl1
Set the tranferemask of this frame to the provided boolean
setWebSocketFactory(WebSocketServer.WebSocketServerFactory) - Method in class org.java_websocket.server.WebSocketServer
 
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
 
SocketChannelIOHelper() - Constructor for class org.java_websocket.SocketChannelIOHelper
 
sslcontext - Variable in class org.java_websocket.server.DefaultSSLWebSocketServerFactory
 
sslEngine - Variable in class org.java_websocket.SSLSocketChannel2
 
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.
START_OF_FRAME - Static variable in class org.java_websocket.drafts.Draft_75
Deprecated.
The byte representing the beginning of a WebSocket text frame.
startConnectionLostTimer() - Method in class org.java_websocket.AbstractWebSocket
Start the connection lost timer
startHandshake(ClientHandshakeBuilder) - Method in class org.java_websocket.WebSocketImpl
 
stop(int) - 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.
stop() - Method in class org.java_websocket.server.WebSocketServer
 
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
 
suspendEncoding() - Method in class org.java_websocket.util.Base64.OutputStream
Suspends encoding of the stream.

T

tasks - Variable in class org.java_websocket.SSLSocketChannel2
 
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.framing.CloseFrame
 
toString() - Method in class org.java_websocket.framing.FramedataImpl1
 
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
 
translateFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 
translateFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
translateFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
translateHandshake(ByteBuffer) - Method in class org.java_websocket.drafts.Draft
 
translateHandshake(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_76
Deprecated.
 
translateHandshakeHttp(ByteBuffer, WebSocket.Role) - Static method in class org.java_websocket.drafts.Draft
 
translateRegularFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_75
Deprecated.
 
translateSingleFrame(ByteBuffer) - Method in class org.java_websocket.drafts.Draft_10
Deprecated.
 

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.
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 org.java_websocket.drafts.Draft.CloseHandshakeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.java_websocket.drafts.Draft.HandshakeState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.java_websocket.framing.Framedata.Opcode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.java_websocket.WebSocket.READYSTATE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.java_websocket.WebSocket.Role
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.java_websocket.drafts.Draft.CloseHandshakeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.java_websocket.drafts.Draft.HandshakeState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.java_websocket.framing.Framedata.Opcode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.java_websocket.WebSocket.READYSTATE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.java_websocket.WebSocket.Role
Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocket - Interface in org.java_websocket
 
WebSocket.READYSTATE - Enum in org.java_websocket
Enum which represents the state a websocket may be in
WebSocket.Role - Enum in org.java_websocket
Enum which represents the states a websocket may be in
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, 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>, 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
WebSocketImpl(WebSocketListener, Draft, Socket) - Constructor for class org.java_websocket.WebSocketImpl
Deprecated.
WebSocketImpl(WebSocketListener, List<Draft>, Socket) - Constructor for class org.java_websocket.WebSocketImpl
Deprecated.
WebSocketListener - Interface in org.java_websocket
Implemented by WebSocketClient and WebSocketServer.
WebsocketNotConnectedException - Exception in org.java_websocket.exceptions
exception which indicates the websocket is not yet connected (READYSTATE.OPEN)
WebsocketNotConnectedException() - Constructor for exception org.java_websocket.exceptions.WebsocketNotConnectedException
constructor for a 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 WebSocket.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, List<Draft>) - 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.WebSocketServerFactory - Interface in org.java_websocket.server
Interface to encapsulate the required methods for a websocket factory
WebSocketServer.WebSocketWorker - Class in org.java_websocket.server
This class is used to process incoming data
WebSocketWorker() - Constructor for class org.java_websocket.server.WebSocketServer.WebSocketWorker
 
workerThread - Variable in class org.java_websocket.WebSocketImpl
Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.
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 interface org.java_websocket.server.WebSocketServer.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
 
write(ByteBuffer) - Method in class org.java_websocket.AbstractWrappedByteChannel
 
write(ByteBuffer) - Method in class org.java_websocket.client.AbstractClientProxyChannel
 
write(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel
 
write(ByteBuffer) - Method in class org.java_websocket.SSLSocketChannel2
 
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(byte[], int, int) - Method in class org.java_websocket.util.Base64.OutputStream
Calls write(int) repeatedly until len bytes are written.
writeEngineResult - Variable in class org.java_websocket.SSLSocketChannel2
 
writeMore() - Method in class org.java_websocket.AbstractWrappedByteChannel
 
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 WrappedByteChannel.isNeedWrite() ()} requires a additional rite
A B C D E F G H I K L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2017. All rights reserved.