web.websockets.WebSocket — clojure-interop/cljs-web-api 1.0.10

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

binary-type cljs

(binary-type this)

Property.

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

var binaryType = aWebSocket.binaryType;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/binaryType

buffered-amount cljs

(buffered-amount this)

Property.

[Read Only]

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

var bufferedAmount = aWebSocket.bufferedAmount;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/bufferedAmount

close cljs

(close this)

Method.

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

WebSocket.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close

constructor cljs

(constructor & args)

Constructor.

The WebSocket() constructor returns a new web.websockets.WebSocket object.

url The URL to which to connect; this should be the URL to which the WebSocket server will respond. protocols Optional Either a single protocol string or an array of protocol strings. These strings are used to indicate sub-protocols, so that a single server can implement multiple WebSocket sub-protocols (for example, you might want one server to be able to handle different types of interactions depending on the specified protocol). If you don't specify a protocol string, an empty string is assumed.

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket

extensions cljs

(extensions this)

Property.

[Read Only]

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

var extensions = aWebSocket.extensions;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/extensions

onclose cljs

(onclose this)

Property.

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

aWebSocket.onclose = function(event) { console.log(\"WebSocket is closed now.\"); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onclose

onerror cljs

(onerror this)

Property.

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

webSocket.onerror = eventHandler;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onerror

onmessage cljs

(onmessage this)

Property.

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

aWebSocket.onmessage = function(event) { console.debug(\"WebSocket message received:\", event); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onmessage

onopen cljs

(onopen this)

Property.

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

aWebSocket.onopen = function(event) { console.log(\"WebSocket is open now.\"); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onopen

protocol cljs

(protocol this)

Property.

[Read Only]

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

var protocol = aWebSocket.protocol;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/protocol

ready-state cljs

(ready-state this)

Property.

[Read Only]

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

var readyState = aWebSocket.readyState;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState

send cljs

(send this & args)

Method.

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

WebSocket.send(\"Hello server!\");

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send

set-binary-type! cljs

(set-binary-type! this val)

Property.

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

var binaryType = aWebSocket.binaryType;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/binaryType

set-onclose! cljs

(set-onclose! this val)

Property.

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

aWebSocket.onclose = function(event) { console.log(\"WebSocket is closed now.\"); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onclose

set-onerror! cljs

(set-onerror! this val)

Property.

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

webSocket.onerror = eventHandler;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onerror

set-onmessage! cljs

(set-onmessage! this val)

Property.

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

aWebSocket.onmessage = function(event) { console.debug(\"WebSocket message received:\", event); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onmessage

set-onopen! cljs

(set-onopen! this val)

Property.

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

aWebSocket.onopen = function(event) { console.log(\"WebSocket is open now.\"); };

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onopen

url cljs

(url this)

Property.

[Read Only]

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

var url = aWebSocket.url;

See also: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/url