akasha

Class WebSocket

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.WebSocket

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="WebSocket")
public class WebSocket
extends EventTarget

The WebSocket object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.

See Also:

WebSocket - MDN, (HTML) # the-websocket-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNonNull java.lang.String	binaryType The WebSocket.binaryType property returns the type of binary data being transmitted by the connection.
static int	CLOSED
static int	CLOSING
static int	CONNECTING
@JsNullable CloseEventHandler	onclose The WebSocket.onclose property is an EventHandler that is called when the WebSocket connection's readyState changes to CLOSED.
@JsNullable EventHandler	onerror The WebSocket interface's onerror event handler property is a function which gets called when an error occurs on the WebSocket.
@JsNullable MessageEventHandler	onmessage The WebSocket.onmessage property is an EventHandler that is called when a message is received from the server.
@JsNullable EventHandler	onopen The WebSocket.onopen property is an EventHandler that is called when the WebSocket connection's readyState changes to 1; this indicates that the connection is ready to send and receive data.
static int	OPEN

Constructor Summary

Constructors

Constructor and Description
WebSocket(java.lang.String url) The WebSocket() constructor returns a new WebSocket object.
WebSocket(java.lang.String url, JsArray<java.lang.String> protocols) The WebSocket() constructor returns a new WebSocket object.
WebSocket(java.lang.String url, java.lang.String protocols) The WebSocket() constructor returns a new WebSocket object.
WebSocket(java.lang.String url, java.lang.String[] protocols) The WebSocket() constructor returns a new WebSocket object.

Method Summary

Modifier and Type	Method and Description
void	addCloseListener(CloseEventListener callback)
void	addCloseListener(CloseEventListener callback, AddEventListenerOptions options)
void	addCloseListener(CloseEventListener callback, boolean useCapture)
void	addErrorListener(EventListener callback)
void	addErrorListener(EventListener callback, AddEventListenerOptions options)
void	addErrorListener(EventListener callback, boolean useCapture)
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
void	addOpenListener(EventListener callback)
void	addOpenListener(EventListener callback, AddEventListenerOptions options)
void	addOpenListener(EventListener callback, boolean useCapture)
int	bufferedAmount() The WebSocket.bufferedAmount read-only property returns the number of bytes of data that have been queued using calls to send() but not yet transmitted to the network.
void	close() The WebSocket.close() method closes the WebSocket connection or connection attempt, if any.
void	close(int code) The WebSocket.close() method closes the WebSocket connection or connection attempt, if any.
void	close(int code, java.lang.String reason) The WebSocket.close() method closes the WebSocket connection or connection attempt, if any.
java.lang.String	extensions() The WebSocket.extensions read-only property returns the extensions selected by the server.
java.lang.String	protocol() The WebSocket.protocol read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object, or the empty string if no connection is established.
int	readyState() The WebSocket.readyState read-only property returns the current state of the WebSocket connection.
void	removeCloseListener(CloseEventListener callback)
void	removeCloseListener(CloseEventListener callback, boolean useCapture)
void	removeCloseListener(CloseEventListener callback, EventListenerOptions options)
void	removeErrorListener(EventListener callback)
void	removeErrorListener(EventListener callback, boolean useCapture)
void	removeErrorListener(EventListener callback, EventListenerOptions options)
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)
void	removeOpenListener(EventListener callback)
void	removeOpenListener(EventListener callback, boolean useCapture)
void	removeOpenListener(EventListener callback, EventListenerOptions options)
void	send(ArrayBuffer data) The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data.
void	send(ArrayBufferView data) The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data.
void	send(Blob data) The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data.
void	send(java.lang.String data) The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data.
java.lang.String	url() The WebSocket.url read-only property returns the absolute URL of the WebSocket as resolved by the constructor.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLOSED

@JsOverlay
public static final int CLOSED

See Also:

Constant Field Values

CLOSING

@JsOverlay
public static final int CLOSING

See Also:

Constant Field Values

CONNECTING

@JsOverlay
public static final int CONNECTING

See Also:

Constant Field Values

OPEN

@JsOverlay
public static final int OPEN

See Also:

Constant Field Values

binaryType

@BinaryType
public @JsNonNull java.lang.String binaryType

The WebSocket.binaryType property returns the type of binary data being transmitted by the connection.

See Also:

WebSocket.binaryType - MDN, WebSocket: binaryType - HTML Living Standard

onclose

public @JsNullable CloseEventHandler onclose

The WebSocket.onclose property is an EventHandler that is called when the WebSocket connection's readyState changes to CLOSED. It is called with a CloseEvent.

See Also:

WebSocket.onclose - MDN, WebSocket: onclose - HTML Living Standard

onerror

public @JsNullable EventHandler onerror

The WebSocket interface's onerror event handler property is a function which gets called when an error occurs on the WebSocket.

See Also:

WebSocket.onerror - MDN, WebSocket: onerror - HTML Living Standard

onmessage

public @JsNullable MessageEventHandler onmessage

The WebSocket.onmessage property is an EventHandler that is called when a message is received from the server. It is called with a MessageEvent.

See Also:

WebSocket.onmessage - MDN, WebSocket: onmessage - HTML Living Standard

onopen

public @JsNullable EventHandler onopen

The WebSocket.onopen property is an EventHandler that is called when the WebSocket connection's readyState changes to 1; this indicates that the connection is ready to send and receive data. It is called with an Event.

See Also:

WebSocket.onopen - MDN, WebSocket: onopen - HTML Living Standard

Constructor Detail

WebSocket

public WebSocket(@Nonnull
                 java.lang.String url,
                 @Nonnull
                 java.lang.String protocols)

The WebSocket() constructor returns a new WebSocket object.

See Also:

WebSocket.WebSocket - MDN, the WebSocket constructor - HTML Living Standard

WebSocket

public WebSocket(@Nonnull
                 java.lang.String url,
                 @Nonnull
                 JsArray<java.lang.String> protocols)

The WebSocket() constructor returns a new WebSocket object.

See Also:

WebSocket.WebSocket - MDN, the WebSocket constructor - HTML Living Standard

WebSocket

public WebSocket(@Nonnull
                 java.lang.String url,
                 @Nonnull
                 java.lang.String[] protocols)

The WebSocket() constructor returns a new WebSocket object.

See Also:

WebSocket.WebSocket - MDN, the WebSocket constructor - HTML Living Standard

WebSocket

public WebSocket(@Nonnull
                 java.lang.String url)

The WebSocket() constructor returns a new WebSocket object.

See Also:

WebSocket.WebSocket - MDN, the WebSocket constructor - HTML Living Standard

Method Detail

bufferedAmount

@JsProperty(name="bufferedAmount")
public int bufferedAmount()

The WebSocket.bufferedAmount read-only property returns the number of bytes of data that have been queued using calls to send() but not yet transmitted to the network. This value resets to zero once all queued data has been sent. This value does not reset to zero when the connection is closed; if you keep calling send(), this will continue to climb.

See Also:

WebSocket.bufferedAmount - MDN, WebSocket: bufferedAmount - HTML Living Standard

extensions

@JsProperty(name="extensions")
 @Nonnull
public java.lang.String extensions()

The WebSocket.extensions read-only property returns the extensions selected by the server. This is currently only the empty string or a list of extensions as negotiated by the connection.

See Also:

WebSocket.extensions - MDN, WebSocket: extensions - HTML Living Standard

protocol

@JsProperty(name="protocol")
 @Nonnull
public java.lang.String protocol()

The WebSocket.protocol read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object, or the empty string if no connection is established.

See Also:

WebSocket.protocol - MDN, WebSocket: protocol - HTML Living Standard

readyState

@JsProperty(name="readyState")
 @WebSocketReadyState
public int readyState()

The WebSocket.readyState read-only property returns the current state of the WebSocket connection.

See Also:

WebSocket.readyState - MDN, WebSocket: readyState - HTML Living Standard

url

@JsProperty(name="url")
 @Nonnull
public java.lang.String url()

The WebSocket.url read-only property returns the absolute URL of the WebSocket as resolved by the constructor.

See Also:

WebSocket.url - MDN, WebSocket: url - HTML Living Standard

close

public void close(int code,
                  @Nonnull
                  java.lang.String reason)

The WebSocket.close() method closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

See Also:

WebSocket.close - MDN, WebSocket.close() - HTML Living Standard

close

public void close(int code)

The WebSocket.close() method closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

See Also:

WebSocket.close - MDN, WebSocket.close() - HTML Living Standard

close

public void close()

The WebSocket.close() method closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

See Also:

WebSocket.close - MDN, WebSocket.close() - HTML Living Standard

send

public void send(@Nonnull
                 java.lang.String data)

The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically.

See Also:

WebSocket.send - MDN, WebSocket: send - HTML Living Standard

send

public void send(@Nonnull
                 Blob data)

The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically.

See Also:

WebSocket.send - MDN, WebSocket: send - HTML Living Standard

send

public void send(@Nonnull
                 ArrayBuffer data)

The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically.

See Also:

WebSocket.send - MDN, WebSocket: send - HTML Living Standard

send

public void send(@Nonnull
                 ArrayBufferView data)

The WebSocket.send() method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically.

See Also:

WebSocket.send - MDN, WebSocket: send - HTML Living Standard

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              CloseEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              CloseEventListener callback,
                                              boolean useCapture)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              CloseEventListener callback)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 CloseEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 CloseEventListener callback,
                                                 boolean useCapture)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 CloseEventListener callback)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                boolean useCapture)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   boolean useCapture)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              EventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 EventListener callback)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback,
                                             boolean useCapture)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback,
                                                boolean useCapture)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback)