A B C D F G H I N O P R S T U V W

A

ABNORMAL - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1006; 1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.

addExtension(WebSocketExtension) - Method in class com.neovisionaries.ws.client.WebSocket

Add a value for Sec-WebSocket-Extension.

addExtension(String) - Method in class com.neovisionaries.ws.client.WebSocket

Add a value for Sec-WebSocket-Extension.

addHeader(String, String) - Method in class com.neovisionaries.ws.client.ProxySettings

Add an additional HTTP header passed to the proxy server.

addHeader(String, String) - Method in class com.neovisionaries.ws.client.WebSocket

Add a pair of extra HTTP header.

addListener(WebSocketListener) - Method in class com.neovisionaries.ws.client.WebSocket

Add a listener to receive events on this WebSocket.

addListeners(List<WebSocketListener>) - Method in class com.neovisionaries.ws.client.WebSocket

Add listeners.

addProtocol(String) - Method in class com.neovisionaries.ws.client.WebSocket

Add a value for Sec-WebSocket-Protocol.

AWAY - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1001; 1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.

B

BINARY - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "binary frame" (0x2).

C

clearExtensions() - Method in class com.neovisionaries.ws.client.WebSocket

Remove all extensions from Sec-WebSocket-Extension.

clearHeaders() - Method in class com.neovisionaries.ws.client.WebSocket

Clear all extra HTTP headers.

clearListeners() - Method in class com.neovisionaries.ws.client.WebSocket

Remove all the listeners from this WebSocket.

clearProtocols() - Method in class com.neovisionaries.ws.client.WebSocket

Remove all protocols from Sec-WebSocket-Protocol.

clearUserInfo() - Method in class com.neovisionaries.ws.client.WebSocket

Clear the credentials to connect to the WebSocket endpoint.

CLOSE - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "connection close" (0x8).

com.neovisionaries.ws.client - package com.neovisionaries.ws.client

High-quality WebSocket client implementation in Java.

connect() - Method in class com.neovisionaries.ws.client.WebSocket

Connect to the server, send an opening handshake to the server, receive the response and then start threads to communicate with the server.

connect(ExecutorService) - Method in class com.neovisionaries.ws.client.WebSocket

Execute WebSocket.connect() asynchronously using the given ExecutorService.

connectable() - Method in class com.neovisionaries.ws.client.WebSocket

Get a new Callable<WebSocket> instance whose call() method calls WebSocket.connect() method of this WebSocket instance.

connectAsynchronously() - Method in class com.neovisionaries.ws.client.WebSocket

Execute WebSocket.connect() asynchronously by creating a new thread and calling connect() in the thread.

containsParameter(String) - Method in class com.neovisionaries.ws.client.WebSocketExtension

Check if the parameter identified by the key is contained.

CONTINUATION - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "frame continuation" (0x0).

createBinaryFrame(byte[]) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a binary frame.

createCloseFrame() - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a close frame.

createCloseFrame(int) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a close frame.

createCloseFrame(int, String) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a close frame.

createContinuationFrame() - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a continuation frame.

createContinuationFrame(byte[]) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a continuation frame.

createContinuationFrame(String) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a continuation frame.

createPingFrame() - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a ping frame.

createPingFrame(byte[]) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a ping frame.

createPingFrame(String) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a ping frame.

createPongFrame() - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a pong frame.

createPongFrame(byte[]) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a pong frame.

createPongFrame(String) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a pong frame.

createSocket(String) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createSocket(String, int) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createSocket(URL) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createSocket(URL, int) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createSocket(URI) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createSocket(URI, int) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Create a WebSocket.

createTextFrame(String) - Static method in class com.neovisionaries.ws.client.WebSocketFrame

Create a text frame.

D

disconnect() - Method in class com.neovisionaries.ws.client.WebSocket

Disconnect the WebSocket.

disconnect(int) - Method in class com.neovisionaries.ws.client.WebSocket

Disconnect the WebSocket.

disconnect(String) - Method in class com.neovisionaries.ws.client.WebSocket

Disconnect the WebSocket.

disconnect(int, String) - Method in class com.neovisionaries.ws.client.WebSocket

Disconnect the WebSocket.

disconnect(int, String, long) - Method in class com.neovisionaries.ws.client.WebSocket

Disconnect the WebSocket.

F

finalize() - Method in class com.neovisionaries.ws.client.WebSocket

flush() - Method in class com.neovisionaries.ws.client.WebSocket

Flush frames to the server.

G

generate() - Method in interface com.neovisionaries.ws.client.PayloadGenerator

Generate a payload of a frame.

getAgreedExtensions() - Method in class com.neovisionaries.ws.client.WebSocket

Get the agreed extensions.

getAgreedProtocol() - Method in class com.neovisionaries.ws.client.WebSocket

Get the agreed protocol.

getBody() - Method in exception com.neovisionaries.ws.client.OpeningHandshakeException

Get the response body contained in the WebSocket opening handshake response from the server.

getCloseCode() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Parse the first two bytes of the payload as a close code.

getCloseReason() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Parse the third and subsequent bytes of the payload as a close reason.

getConnectionTimeout() - Method in class com.neovisionaries.ws.client.WebSocketFactory

Get the timeout value in milliseconds for socket connection.

getError() - Method in exception com.neovisionaries.ws.client.WebSocketException

getFin() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the value of FIN bit.

getFrameQueueSize() - Method in class com.neovisionaries.ws.client.WebSocket

Get the size of the frame queue.

getHeaders() - Method in exception com.neovisionaries.ws.client.OpeningHandshakeException

Get the HTTP headers contained in the WebSocket opening handshake response from the server.

getHeaders() - Method in class com.neovisionaries.ws.client.ProxySettings

Get additional HTTP headers passed to the proxy server.

getHost() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the host name of the proxy server.

getHostname() - Method in exception com.neovisionaries.ws.client.HostnameUnverifiedException

Get the expected hostname.

getHttpVersion() - Method in class com.neovisionaries.ws.client.StatusLine

Get the HTTP version.

getId() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the ID for authentication at the proxy server.

getMaxPayloadSize() - Method in class com.neovisionaries.ws.client.WebSocket

Get the maximum payload size.

getName() - Method in class com.neovisionaries.ws.client.WebSocketExtension

Get the extension name.

getOpcode() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the opcode.

getParameter(String) - Method in class com.neovisionaries.ws.client.WebSocketExtension

Get the value of the specified parameter.

getParameters() - Method in class com.neovisionaries.ws.client.WebSocketExtension

Get the parameters.

getPassword() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the password for authentication at the proxy server.

getPayload() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the unmasked payload.

getPayloadLength() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the payload length.

getPayloadText() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the unmasked payload as a text.

getPingInterval() - Method in class com.neovisionaries.ws.client.WebSocket

Get the interval of periodical ping frames.

getPingPayloadGenerator() - Method in class com.neovisionaries.ws.client.WebSocket

Get the generator of payload of ping frames that are sent automatically.

getPongInterval() - Method in class com.neovisionaries.ws.client.WebSocket

Get the interval of periodical pong frames.

getPongPayloadGenerator() - Method in class com.neovisionaries.ws.client.WebSocket

Get the generator of payload of pong frames that are sent automatically.

getPort() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the port number of the proxy server.

getProxySettings() - Method in class com.neovisionaries.ws.client.WebSocketFactory

Get the proxy settings.

getReasonPhrase() - Method in class com.neovisionaries.ws.client.StatusLine

Get the reason phrase.

getRsv1() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the value of RSV1 bit.

getRsv2() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the value of RSV2 bit.

getRsv3() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Get the value of RSV3 bit.

getSocket() - Method in class com.neovisionaries.ws.client.WebSocket

Get the raw socket which this WebSocket uses internally.

getSocketFactory() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the socket factory that has been set by ProxySettings.setSocketFactory(SocketFactory).

getSocketFactory() - Method in class com.neovisionaries.ws.client.WebSocketFactory

Get the socket factory that has been set by WebSocketFactory.setSocketFactory(SocketFactory).

getSSLContext() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the SSL context that has been set by ProxySettings.setSSLContext(SSLContext).

getSSLContext() - Method in class com.neovisionaries.ws.client.WebSocketFactory

Get the SSL context that has been set by WebSocketFactory.setSSLContext(SSLContext).

getSSLSocket() - Method in exception com.neovisionaries.ws.client.HostnameUnverifiedException

Get the SSL socket against which the hostname verification failed.

getSSLSocketFactory() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the SSL socket factory that has been set by ProxySettings.setSSLSocketFactory(SSLSocketFactory).

getSSLSocketFactory() - Method in class com.neovisionaries.ws.client.WebSocketFactory

Get the SSL socket factory that has been set by WebSocketFactory.setSSLSocketFactory(SSLSocketFactory).

getState() - Method in class com.neovisionaries.ws.client.WebSocket

Get the current state of this WebSocket.

getStatusCode() - Method in class com.neovisionaries.ws.client.StatusLine

Get the status code.

getStatusLine() - Method in exception com.neovisionaries.ws.client.OpeningHandshakeException

Get the status line contained in the WebSocket opening handshake response from the server.

getURI() - Method in class com.neovisionaries.ws.client.WebSocket

Get the URI of the WebSocket endpoint.

getWebSocketFactory() - Method in class com.neovisionaries.ws.client.ProxySettings

Get the associated WebSocketFactory instance.

H

handleCallbackError(WebSocket, Throwable) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

handleCallbackError(WebSocket, Throwable) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when an onXxx() method threw a Throwable.

hasPayload() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame has payload.

HostnameUnverifiedException - Exception in com.neovisionaries.ws.client

The certificate of the peer does not match the expected hostname.

HostnameUnverifiedException(SSLSocket, String) - Constructor for exception com.neovisionaries.ws.client.HostnameUnverifiedException

Constructor with the SSL socket and the expected hostname.

I

INCONSISTENT - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1007; 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).

INSECURE - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1015; 1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).

isAutoFlush() - Method in class com.neovisionaries.ws.client.WebSocket

Check if flush is performed automatically after WebSocket.sendFrame(WebSocketFrame) is done.

isBinaryFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a binary frame.

isCloseFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a close frame.

isContinuationFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a continuation frame.

isControlFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a control frame.

isDataFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a data frame.

isExtended() - Method in class com.neovisionaries.ws.client.WebSocket

Check if extended use of WebSocket frames are allowed.

isMissingCloseFrameAllowed() - Method in class com.neovisionaries.ws.client.WebSocket

Check if this instance allows the server to close the WebSocket connection without sending a close frame to this client.

isOpen() - Method in class com.neovisionaries.ws.client.WebSocket

Check if the current state of this WebSocket is OPEN.

isPingFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a ping frame.

isPongFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a pong frame.

isSecure() - Method in class com.neovisionaries.ws.client.ProxySettings

Check whether use of TLS is enabled or disabled.

isTextFrame() - Method in class com.neovisionaries.ws.client.WebSocketFrame

Check if this frame is a text frame.

N

NONE - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1005; 1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.

NORMAL - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1000; 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

O

onBinaryFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onBinaryFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a binary frame (opcode = 0x2) was received.

onBinaryMessage(WebSocket, byte[]) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onBinaryMessage(WebSocket, byte[]) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a binary message was received.

onCloseFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onCloseFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a close frame (opcode = 0x8) was received.

onConnected(WebSocket, Map<String, List<String>>) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onConnected(WebSocket, Map<String, List<String>>) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called after the opening handshake of the WebSocket connection succeeded.

onConnectError(WebSocket, WebSocketException) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onConnectError(WebSocket, WebSocketException) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when WebSocket.connectAsynchronously() failed.

onContinuationFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onContinuationFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a continuation frame (opcode = 0x0) was received.

onDisconnected(WebSocket, WebSocketFrame, WebSocketFrame, boolean) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onDisconnected(WebSocket, WebSocketFrame, WebSocketFrame, boolean) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called after the WebSocket connection was closed.

onError(WebSocket, WebSocketException) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onError(WebSocket, WebSocketException) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Call when an error occurred.

onFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a frame was received.

onFrameError(WebSocket, WebSocketException, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onFrameError(WebSocket, WebSocketException, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a WebSocket frame failed to be read from the WebSocket.

onFrameSent(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onFrameSent(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a WebSocket frame was sent to the server (but not flushed yet).

onFrameUnsent(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onFrameUnsent(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a WebSocket frame was not sent to the server because a close frame has already been sent.

onMessageDecompressionError(WebSocket, WebSocketException, byte[]) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onMessageDecompressionError(WebSocket, WebSocketException, byte[]) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a message failed to be decompressed.

onMessageError(WebSocket, WebSocketException, List<WebSocketFrame>) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onMessageError(WebSocket, WebSocketException, List<WebSocketFrame>) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when it failed to concatenate payloads of multiple frames to construct a message.

onPingFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onPingFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a ping frame (opcode = 0x9) was received.

onPongFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onPongFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a pong frame (opcode = 0xA) was received.

onSendError(WebSocket, WebSocketException, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onSendError(WebSocket, WebSocketException, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when an error occurred when a frame was tried to be sent to the server.

onSendingFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onSendingFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called before a WebSocket frame is sent.

onSendingHandshake(WebSocket, String, List<String[]>) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onSendingHandshake(WebSocket, String, List<String[]>) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called before an opening handshake is sent to the server.

onStateChanged(WebSocket, WebSocketState) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onStateChanged(WebSocket, WebSocketState) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called after the state of the WebSocket changed.

onTextFrame(WebSocket, WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onTextFrame(WebSocket, WebSocketFrame) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a text frame (opcode = 0x1) was received.

onTextMessage(WebSocket, String) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onTextMessage(WebSocket, String) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when a text message was received.

onTextMessageError(WebSocket, WebSocketException, byte[]) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onTextMessageError(WebSocket, WebSocketException, byte[]) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when it failed to convert payload data into a string.

onThreadCreated(WebSocket, ThreadType, Thread) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onThreadCreated(WebSocket, ThreadType, Thread) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called between after a thread is created and before the thread's start() method is called.

onThreadStarted(WebSocket, ThreadType, Thread) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onThreadStarted(WebSocket, ThreadType, Thread) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called at the very beginning of the thread's run() method implementation.

onThreadStopping(WebSocket, ThreadType, Thread) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onThreadStopping(WebSocket, ThreadType, Thread) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called at the very end of the thread's run() method implementation.

onUnexpectedError(WebSocket, WebSocketException) - Method in class com.neovisionaries.ws.client.WebSocketAdapter

onUnexpectedError(WebSocket, WebSocketException) - Method in interface com.neovisionaries.ws.client.WebSocketListener

Called when an uncaught throwable was detected in either the reading thread (which reads frames from the server) or the writing thread (which sends frames to the server).

OpeningHandshakeException - Exception in com.neovisionaries.ws.client

An exception raised due to a violation against the WebSocket protocol.

OVERSIZE - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1009; 1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

P

parse(String) - Static method in class com.neovisionaries.ws.client.WebSocketExtension

Parse a string as a WebSocketExtension.

PayloadGenerator - Interface in com.neovisionaries.ws.client

Payload generator.

PERMESSAGE_DEFLATE - Static variable in class com.neovisionaries.ws.client.WebSocketExtension

The name of permessage-deflate extension that is defined in 7. The "permessage-deflate" Extension in RFC 7692.

PING - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "ping" (0x9).

PONG - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "pong" (0xA).

ProxySettings - Class in com.neovisionaries.ws.client

Proxy settings.

R

recreate() - Method in class com.neovisionaries.ws.client.WebSocket

Create a new WebSocket instance that has the same settings as this instance.

recreate(int) - Method in class com.neovisionaries.ws.client.WebSocket

Create a new WebSocket instance that has the same settings as this instance.

removeExtension(WebSocketExtension) - Method in class com.neovisionaries.ws.client.WebSocket

Remove an extension from Sec-WebSocket-Extension.

removeExtensions(String) - Method in class com.neovisionaries.ws.client.WebSocket

Remove extensions from Sec-WebSocket-Extension by an extension name.

removeHeaders(String) - Method in class com.neovisionaries.ws.client.WebSocket

Remove pairs of extra HTTP headers.

removeListener(WebSocketListener) - Method in class com.neovisionaries.ws.client.WebSocket

Remove a listener from this WebSocket.

removeListeners(List<WebSocketListener>) - Method in class com.neovisionaries.ws.client.WebSocket

Remove listeners.

removeProtocol(String) - Method in class com.neovisionaries.ws.client.WebSocket

Remove a protocol from Sec-WebSocket-Protocol.

reset() - Method in class com.neovisionaries.ws.client.ProxySettings

Reset the proxy settings.

S

sendBinary(byte[]) - Method in class com.neovisionaries.ws.client.WebSocket

Send a binary message to the server.

sendBinary(byte[], boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Send a binary frame to the server.

sendClose() - Method in class com.neovisionaries.ws.client.WebSocket

Send a close frame to the server.

sendClose(int) - Method in class com.neovisionaries.ws.client.WebSocket

Send a close frame to the server.

sendClose(int, String) - Method in class com.neovisionaries.ws.client.WebSocket

Send a close frame to the server.

sendContinuation() - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendContinuation(boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendContinuation(String) - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendContinuation(String, boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendContinuation(byte[]) - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendContinuation(byte[], boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Send a continuation frame to the server.

sendFrame(WebSocketFrame) - Method in class com.neovisionaries.ws.client.WebSocket

Send a WebSocket frame to the server.

sendPing() - Method in class com.neovisionaries.ws.client.WebSocket

Send a ping frame to the server.

sendPing(byte[]) - Method in class com.neovisionaries.ws.client.WebSocket

Send a ping frame to the server.

sendPing(String) - Method in class com.neovisionaries.ws.client.WebSocket

Send a ping frame to the server.

sendPong() - Method in class com.neovisionaries.ws.client.WebSocket

Send a pong frame to the server.

sendPong(byte[]) - Method in class com.neovisionaries.ws.client.WebSocket

Send a pong frame to the server.

sendPong(String) - Method in class com.neovisionaries.ws.client.WebSocket

Send a pong frame to the server.

sendText(String) - Method in class com.neovisionaries.ws.client.WebSocket

Send a text message to the server.

sendText(String, boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Send a text frame to the server.

setAutoFlush(boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Enable or disable auto-flush of sent frames.

setCloseFramePayload(int, String) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the payload that conforms to the payload format of close frames.

setConnectionTimeout(int) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Set the timeout value in milliseconds for socket connection.

setCredentials(String, String) - Method in class com.neovisionaries.ws.client.ProxySettings

Set credentials for authentication at the proxy server.

setExtended(boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Allow or disallow extended use of WebSocket frames.

setFin(boolean) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the value of FIN bit.

setFrameQueueSize(int) - Method in class com.neovisionaries.ws.client.WebSocket

Set the size of the frame queue.

setHost(String) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the host name of the proxy server.

setId(String) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the ID for authentication at the proxy server.

setMaxPayloadSize(int) - Method in class com.neovisionaries.ws.client.WebSocket

Set the maximum payload size.

setMissingCloseFrameAllowed(boolean) - Method in class com.neovisionaries.ws.client.WebSocket

Set whether to allow the server to close the WebSocket connection without sending a close frame to this client.

setOpcode(int) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the opcode

setParameter(String, String) - Method in class com.neovisionaries.ws.client.WebSocketExtension

Set a value to the specified parameter.

setPassword(String) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the password for authentication at the proxy server.

setPayload(byte[]) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the unmasked payload.

setPayload(String) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the payload.

setPingInterval(long) - Method in class com.neovisionaries.ws.client.WebSocket

Set the interval of periodical ping frames.

setPingPayloadGenerator(PayloadGenerator) - Method in class com.neovisionaries.ws.client.WebSocket

Set the generator of payload of ping frames that are sent automatically.

setPongInterval(long) - Method in class com.neovisionaries.ws.client.WebSocket

Set the interval of periodical pong frames.

setPongPayloadGenerator(PayloadGenerator) - Method in class com.neovisionaries.ws.client.WebSocket

Set the generator of payload of pong frames that are sent automatically.

setPort(int) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the port number of the proxy server.

setRsv1(boolean) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the value of RSV1 bit.

setRsv2(boolean) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the value of RSV2 bit.

setRsv3(boolean) - Method in class com.neovisionaries.ws.client.WebSocketFrame

Set the value of RSV3 bit.

setSecure(boolean) - Method in class com.neovisionaries.ws.client.ProxySettings

Enable or disable use of TLS.

setServer(String) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the proxy server by a URI.

setServer(URL) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the proxy server by a URL.

setServer(URI) - Method in class com.neovisionaries.ws.client.ProxySettings

Set the proxy server by a URI.

setSocketFactory(SocketFactory) - Method in class com.neovisionaries.ws.client.ProxySettings

Set a socket factory.

setSocketFactory(SocketFactory) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Set a socket factory.

setSSLContext(SSLContext) - Method in class com.neovisionaries.ws.client.ProxySettings

Set an SSL context to get a socket factory.

setSSLContext(SSLContext) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Set an SSL context to get a socket factory.

setSSLSocketFactory(SSLSocketFactory) - Method in class com.neovisionaries.ws.client.ProxySettings

Set an SSL socket factory.

setSSLSocketFactory(SSLSocketFactory) - Method in class com.neovisionaries.ws.client.WebSocketFactory

Set an SSL socket factory.

setUserInfo(String) - Method in class com.neovisionaries.ws.client.WebSocket

Set the credentials to connect to the WebSocket endpoint.

setUserInfo(String, String) - Method in class com.neovisionaries.ws.client.WebSocket

Set the credentials to connect to the WebSocket endpoint.

StatusLine - Class in com.neovisionaries.ws.client

HTTP status line returned from an HTTP server.

T

TEXT - Static variable in class com.neovisionaries.ws.client.WebSocketOpcode

Opcode for "text frame" (0x1).

ThreadType - Enum in com.neovisionaries.ws.client

Types of threads which are created internally in the implementation.

toString() - Method in class com.neovisionaries.ws.client.StatusLine

Get the string representation of this instance, which is equal to the raw status line.

toString() - Method in class com.neovisionaries.ws.client.WebSocketExtension

Stringify this object into the format "{name}[; {key}[={value}]]*".

toString() - Method in class com.neovisionaries.ws.client.WebSocketFrame

U

UNACCEPTABLE - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1003; 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).

UNCONFORMED - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1002; 1002 indicates that an endpoint is terminating the connection due to a protocol error.

UNEXPECTED - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1011; 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

UNEXTENDED - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1010; 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. The list of extensions that are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.

V

valueOf(String) - Static method in enum com.neovisionaries.ws.client.ThreadType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.neovisionaries.ws.client.WebSocketError

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.neovisionaries.ws.client.WebSocketState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.neovisionaries.ws.client.ThreadType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.neovisionaries.ws.client.WebSocketError

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.neovisionaries.ws.client.WebSocketState

Returns an array containing the constants of this enum type, in the order they are declared.

VIOLATED - Static variable in class com.neovisionaries.ws.client.WebSocketCloseCode

1008; 1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the policy.

W

WebSocket - Class in com.neovisionaries.ws.client

WebSocket.

WebSocketAdapter - Class in com.neovisionaries.ws.client

An empty implementation of WebSocketListener interface.

WebSocketAdapter() - Constructor for class com.neovisionaries.ws.client.WebSocketAdapter

WebSocketCloseCode - Class in com.neovisionaries.ws.client

Close code.

WebSocketError - Enum in com.neovisionaries.ws.client

WebSocket error codes.

WebSocketException - Exception in com.neovisionaries.ws.client

WebSocket exception.

WebSocketException(WebSocketError) - Constructor for exception com.neovisionaries.ws.client.WebSocketException

WebSocketException(WebSocketError, String) - Constructor for exception com.neovisionaries.ws.client.WebSocketException

WebSocketException(WebSocketError, Throwable) - Constructor for exception com.neovisionaries.ws.client.WebSocketException

WebSocketException(WebSocketError, String, Throwable) - Constructor for exception com.neovisionaries.ws.client.WebSocketException

WebSocketExtension - Class in com.neovisionaries.ws.client

A class to hold the name and the parameters of a WebSocket extension.

WebSocketExtension(String) - Constructor for class com.neovisionaries.ws.client.WebSocketExtension

Constructor with an extension name.

WebSocketExtension(WebSocketExtension) - Constructor for class com.neovisionaries.ws.client.WebSocketExtension

Copy constructor.

WebSocketFactory - Class in com.neovisionaries.ws.client

Factory to create WebSocket instances.

WebSocketFactory() - Constructor for class com.neovisionaries.ws.client.WebSocketFactory

WebSocketFrame - Class in com.neovisionaries.ws.client

WebSocket frame.

WebSocketFrame() - Constructor for class com.neovisionaries.ws.client.WebSocketFrame

WebSocketListener - Interface in com.neovisionaries.ws.client

Listener interface to receive WebSocket events.

WebSocketOpcode - Class in com.neovisionaries.ws.client

Opcode.

WebSocketState - Enum in com.neovisionaries.ws.client

WebSocket state.

A B C D F G H I N O P R S T U V W