aboutsummaryrefslogtreecommitdiffstats
path: root/components/script/dom/webidls/WebSocket.webidl
blob: 6067ca30c4f746ff9adf5455ed40d506732f74b2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

enum BinaryType { "blob", "arraybuffer" };

[Constructor(DOMString url)]
interface WebSocket : EventTarget {
    readonly attribute DOMString url;
    //ready state
    const unsigned short CONNECTING = 0;
    const unsigned short OPEN = 1;
    const unsigned short CLOSING = 2;
    const unsigned short CLOSED = 3;
    readonly attribute unsigned short readyState;
    //readonly attribute unsigned long bufferedAmount;

    //networking
    attribute EventHandler onopen;
    attribute EventHandler onerror;
    attribute EventHandler onclose;
    //readonly attribute DOMString extensions;
    //readonly attribute DOMString protocol;
    //[Throws] void close([Clamp] optional unsigned short code, optional DOMString reason); //Clamp doesn't work
    [Throws] void close(optional unsigned short code, optional DOMString reason); //No clamp version - works

    //messaging
    //attribute EventHandler onmessage;
    //attribute BinaryType binaryType;
    [Throws] void send(optional DOMString data);
    //void send(Blob data);
    //void send(ArrayBuffer data);
    //void send(ArrayBufferView data);

};