dom/webidl/DataChannel.webidl
author Randell Jesup <rjesup@jesup.org>
Mon, 28 Sep 2015 19:02:23 -0400
changeset 264859 23cd3f0edf0af2974c1c53a6e8f913733561be53
parent 147447 8fa498beb80566677963cbe61297516f544ee6e0
child 302366 a048fe8e467d8f5eb1200856235a226f42724505
permissions -rw-r--r--
Bug 1178091: Implement RTCDataChannel BufferedAmountLowThreshold and bufferedamountlow event r=smaug,drno

/* 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/. */

enum RTCDataChannelState {
  "connecting",
  "open",
  "closing",
  "closed"
};

enum RTCDataChannelType {
  "arraybuffer",
  "blob"
};

// XXX This interface is called RTCDataChannel in the spec.
interface DataChannel : EventTarget
{
  readonly attribute DOMString label;
  readonly attribute boolean reliable;
  readonly attribute RTCDataChannelState readyState;
  readonly attribute unsigned long bufferedAmount;
  attribute unsigned long bufferedAmountLowThreshold;
  attribute EventHandler onopen;
  attribute EventHandler onerror;
  attribute EventHandler onclose;
  void close();
  attribute EventHandler onmessage;
  attribute EventHandler onbufferedamountlow;
  attribute RTCDataChannelType binaryType;
  [Throws]
  void send(DOMString data);
  [Throws]
  void send(Blob data);
  [Throws]
  void send(ArrayBuffer data);
  [Throws]
  void send(ArrayBufferView data);
};

// Mozilla extensions.
partial interface DataChannel
{
  readonly attribute DOMString protocol;
  readonly attribute boolean ordered;
  readonly attribute unsigned short id;
  // this is deprecated due to renaming in the spec, but still supported for Fx22
  readonly attribute unsigned short stream; // now id
};