2009-12-16 Fumitoshi Ukai <ukai@chromium.org>
[WebKit-https.git] / WebCore / websockets / WebSocket.idl
1 /*
2  * Copyright (C) 2009 Google Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 module websockets {
32
33     interface [
34         Conditional=WEB_SOCKETS,
35         EventTarget,
36         NoStaticTables
37     ] WebSocket {
38         readonly attribute DOMString URL;
39
40         // ready state
41         const unsigned short CONNECTING = 0;
42         const unsigned short OPEN = 1;
43         const unsigned short CLOSED = 2;
44         readonly attribute unsigned short readyState;
45
46         readonly attribute unsigned long bufferedAmount;
47
48         // networking
49         attribute EventListener onopen;
50         attribute EventListener onmessage;
51         attribute EventListener onclose;
52
53         [Custom] boolean send(in DOMString data)
54           raises(DOMException);
55         void close();
56
57         // EventTarget interface
58         [Custom] void addEventListener(in DOMString type,
59                                        in EventListener listener,
60                                        in boolean useCapture);
61         [Custom] void removeEventListener(in DOMString type,
62                                           in EventListener listener,
63                                           in boolean useCapture);
64         boolean dispatchEvent(in Event evt)
65             raises(EventException);
66     };
67 }