dom/webidl/WebSocket.webidl
author Manish Goregaokar <manishearth@gmail.com>
Sat, 02 Mar 2019 04:21:33 +0000
changeset 519958 f4ec249fc52a26c94b9d04cad859faf32689267c
parent 519953 0c70617150d9a41cb2f2f4fafcab9ae50c15ddd1
permissions -rw-r--r--
Bug 1359269 - Part 5: Add support for attributes on types in arguments; r=bzbarsky Depends on D19736 Differential Revision: https://phabricator.services.mozilla.com/D19737

/* -*- 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(optional [Clamp] 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
// devtools remote debugging server.
interface nsITransportProvider;

partial interface WebSocket {
  [ChromeOnly, NewObject, Throws]
  static WebSocket createServerWebSocket(DOMString url,
                                         sequence<DOMString> protocols,
                                         nsITransportProvider transportProvider,
                                         DOMString negotiatedExtensions);
};