1/*
2 * Copyright (C) 2009 Google Inc.  All rights reserved.
3 * Copyright (C) 2010, 2011 Apple Inc. All Rights Reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 *     * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *     * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 *     * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32[
33    GlobalContext=DOMWindow&WorkerGlobalScope,
34    EnabledAtRuntime,
35    Conditional=WEB_SOCKETS,
36    ActiveDOMObject,
37    Constructor(DOMString url, [Default=Undefined] optional sequence<DOMString>? protocols),
38    Constructor(DOMString url, DOMString protocol),
39    ConstructorRaisesException,
40    ConstructorCallWith=ScriptExecutionContext,
41    EventTarget,
42    JSNoStaticTables,
43] interface WebSocket {
44    readonly attribute DOMString URL; // Lowercased .url is the one in the spec, but leaving .URL for compatibility reasons.
45    readonly attribute DOMString url;
46
47    // ready state
48    const unsigned short CONNECTING = 0;
49    const unsigned short OPEN = 1;
50    const unsigned short CLOSING = 2;
51    const unsigned short CLOSED = 3;
52    readonly attribute unsigned short readyState;
53
54    readonly attribute unsigned long bufferedAmount;
55
56    // networking
57    attribute EventListener onopen;
58    attribute EventListener onmessage;
59    attribute EventListener onerror;
60    attribute EventListener onclose;
61
62    [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString protocol;
63    [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString extensions;
64
65    attribute DOMString binaryType;
66
67    [RaisesException] void send(ArrayBuffer data);
68    [RaisesException] void send(ArrayBufferView data);
69    [RaisesException] void send(Blob data);
70    [RaisesException] void send(DOMString data);
71
72    [RaisesException] void close([Clamp] optional unsigned short code, optional DOMString reason);
73
74    // EventTarget interface
75    void addEventListener(DOMString type,
76                          EventListener listener,
77                          optional boolean useCapture);
78    void removeEventListener(DOMString type,
79                             EventListener listener,
80                             optional boolean useCapture);
81    [RaisesException] boolean dispatchEvent(Event evt);
82};
83