WebSocket

Description

Properties

Name	Type	Summary
binaryType	string	Not used. Default Value: "blob"
bufferedAmount	number	Not implemented. Read-only. Default Value: 0
extensions	string	Not implemented. Read-only. Default Value: ""
onopen	WebSocket~onOpenCallback	Function called when the connection opens.
onmessage	WebSocket~onMessageCallback	Function called when a message is received.
onerror	WebSocket~onErrorCallback	Function called when an error occurs.
onclose	WebSocket~onCloseCallback	Function called when the connection closes.
protocol	string	Not implemented. Read-only. Default Value: ""
readyState	WebSocket.ReadyState	The state of the connection. Read-only.
url	string	The URL to connect to. Read-only.
CONNECTING	WebSocket.ReadyState	The connection is opening. Read-only.
OPEN	WebSocket.ReadyState	The connection is open. Read-only.
CLOSING	WebSocket.ReadyState	The connection is closing. Read-only.
CLOSED	WebSocket.ReadyState	The connection is closed. Read-only.

Constructor
new WebSocket( urlOrWebSocket ) Parameters Name Type Description urlOrWebSocket string | WebSocket The URL to connect to or an existing WebSocket to reuse the connection of.

Example

Echo a message off websocket.org.

print("Create WebSocket");
var WEBSOCKET_PING_URL = "ws://echo.websocket.org";
var webSocket = new WebSocket(WEBSOCKET_PING_URL);

webSocket.onclose = function (data) {
    print("WebSocket closed");
    print("Ready state =", webSocket.readyState);  // 3
};

webSocket.onmessage = function (data) {
    print("Message received:", data.data);

    print("Close WebSocket");
    webSocket.close();
};

webSocket.onopen = function () {
    print("WebSocket opened");
    print("Ready state =", webSocket.readyState);  // 1

    print("Send a test message");
    webSocket.send("Test message");
};