dom/webidl/WebSocket.webidl@b8a032363ba2 (annotated)
dom/webidl/WebSocket.webidl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this file, |
| michael@0 | 4 | * You can obtain one at http://mozilla.org/MPL/2.0/. |
| michael@0 | 5 | * |
| michael@0 | 6 | * The origin of this IDL file is |
| michael@0 | 7 | * http://www.whatwg.org/html/#network |
| michael@0 | 8 | * |
| michael@0 | 9 | * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and Opera Software ASA. |
| michael@0 | 10 | * You are granted a license to use, reproduce and create derivative works of this document. |
| michael@0 | 11 | */ |
| michael@0 | 12 | |
| michael@0 | 13 | enum BinaryType { "blob", "arraybuffer" }; |
| michael@0 | 14 | |
| michael@0 | 15 | [Func="mozilla::dom::WebSocket::PrefEnabled", |
| michael@0 | 16 | Constructor(DOMString url), |
| michael@0 | 17 | Constructor(DOMString url, DOMString protocols), |
| michael@0 | 18 | Constructor(DOMString url, sequence<DOMString> protocols)] |
| michael@0 | 19 | interface WebSocket : EventTarget { |
| michael@0 | 20 | |
| michael@0 | 21 | readonly attribute DOMString url; |
| michael@0 | 22 | |
| michael@0 | 23 | // ready state |
| michael@0 | 24 | const unsigned short CONNECTING = 0; |
| michael@0 | 25 | const unsigned short OPEN = 1; |
| michael@0 | 26 | const unsigned short CLOSING = 2; |
| michael@0 | 27 | const unsigned short CLOSED = 3; |
| michael@0 | 28 | |
| michael@0 | 29 | readonly attribute unsigned short readyState; |
| michael@0 | 30 | |
| michael@0 | 31 | readonly attribute unsigned long bufferedAmount; |
| michael@0 | 32 | |
| michael@0 | 33 | // networking |
| michael@0 | 34 | |
| michael@0 | 35 | attribute EventHandler onopen; |
| michael@0 | 36 | |
| michael@0 | 37 | attribute EventHandler onerror; |
| michael@0 | 38 | |
| michael@0 | 39 | attribute EventHandler onclose; |
| michael@0 | 40 | |
| michael@0 | 41 | readonly attribute DOMString extensions; |
| michael@0 | 42 | |
| michael@0 | 43 | readonly attribute DOMString protocol; |
| michael@0 | 44 | |
| michael@0 | 45 | [Throws] |
| michael@0 | 46 | void close([Clamp] optional unsigned short code, optional DOMString reason); |
| michael@0 | 47 | |
| michael@0 | 48 | // messaging |
| michael@0 | 49 | |
| michael@0 | 50 | attribute EventHandler onmessage; |
| michael@0 | 51 | |
| michael@0 | 52 | attribute BinaryType binaryType; |
| michael@0 | 53 | |
| michael@0 | 54 | [Throws] |
| michael@0 | 55 | void send(DOMString data); |
| michael@0 | 56 | |
| michael@0 | 57 | [Throws] |
| michael@0 | 58 | void send(Blob data); |
| michael@0 | 59 | |
| michael@0 | 60 | [Throws] |
| michael@0 | 61 | void send(ArrayBuffer data); |
| michael@0 | 62 | |
| michael@0 | 63 | [Throws] |
| michael@0 | 64 | void send(ArrayBufferView data); |
| michael@0 | 65 | }; |
