59db56112663a5a6f434d1f29e36b6cb9f7152b6
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocket.idl
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     Conditional=WEB_SOCKETS,
34     ActiveDOMObject,
35     Constructor(DOMString url),
36     Constructor(DOMString url, sequence<DOMString> protocols),
37     Constructor(DOMString url, DOMString protocol),
38     ConstructorRaisesException,
39     CallWith=ScriptExecutionContext,
40     EventTarget,
41     JSNoStaticTables,
42     ConstructorParameters=1
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     void send(ArrayBuffer data)
68         raises(DOMException);
69     void send(ArrayBufferView data)
70         raises(DOMException);
71     void send(Blob data)
72         raises(DOMException);
73     void send(DOMString data)
74         raises(DOMException);
75
76     void close([Clamp] optional unsigned short code, optional DOMString reason) raises(DOMException);
77
78     // EventTarget interface
79     void addEventListener(DOMString type,
80                           EventListener listener,
81                           optional boolean useCapture);
82     void removeEventListener(DOMString type,
83                              EventListener listener,
84                              optional boolean useCapture);
85     boolean dispatchEvent(Event evt)
86         raises(EventException);
87 };