diff options
Diffstat (limited to 'dom/webidl/WebSocket.webidl')
-rw-r--r-- | dom/webidl/WebSocket.webidl | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/dom/webidl/WebSocket.webidl b/dom/webidl/WebSocket.webidl new file mode 100644 index 000000000..492e366ba --- /dev/null +++ b/dom/webidl/WebSocket.webidl @@ -0,0 +1,77 @@ +/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* 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/. + * + * The origin of this IDL file is + * http://www.whatwg.org/html/#network + * + * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and Opera Software ASA. + * You are granted a license to use, reproduce and create derivative works of this document. + */ + +enum BinaryType { "blob", "arraybuffer" }; + +[Exposed=(Window,Worker), + Constructor(DOMString url), + Constructor(DOMString url, DOMString protocols), + Constructor(DOMString url, sequence<DOMString> protocols)] +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); + + // messaging + + attribute EventHandler onmessage; + + attribute BinaryType binaryType; + + [Throws] + void send(DOMString data); + + [Throws] + void send(Blob data); + + [Throws] + void send(ArrayBuffer data); + + [Throws] + void send(ArrayBufferView data); +}; + +// Support for creating server-side chrome-only WebSocket. Used in FlyWeb and in +// devtools remote debugging server. +interface nsITransportProvider; + +partial interface WebSocket { + [ChromeOnly, NewObject, Throws] + static WebSocket createServerWebSocket(DOMString url, + sequence<DOMString> protocols, + nsITransportProvider transportProvider, + DOMString negotiatedExtensions); +}; |