modules/peerconnection/RTCDataChannel.idl

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

// https://w3c.github.io/webrtc-pc/#idl-def-rtcdatachannelstate

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

// https://w3c.github.io/webrtc-pc/#rtcdatachannel

[
    ActiveScriptWrappable,
    DependentLifetime
] interface RTCDataChannel : EventTarget {
    readonly attribute USVString label;
    readonly attribute boolean ordered;
    // TODO(foolip): |maxRetransmitTime| is called |maxPacketLifeTime| in the
    // spec and both it and |maxRetransmits| are nullable.
    [Measure] readonly attribute unsigned short maxRetransmitTime;
    [Measure] readonly attribute unsigned short maxRetransmits;
    readonly attribute USVString protocol;
    readonly attribute boolean negotiated;
    readonly attribute unsigned short id;
    readonly attribute RTCDataChannelState readyState;
    readonly attribute unsigned long bufferedAmount;
             attribute unsigned long bufferedAmountLowThreshold;
             attribute EventHandler onopen;
             attribute EventHandler onbufferedamountlow;
             attribute EventHandler onerror;
             attribute EventHandler onclose;
    void close();
             attribute EventHandler onmessage;
    [RaisesException=Setter] attribute DOMString binaryType;
    // TODO(foolip): |data| should be USVString.
    [RaisesException] void send(DOMString data);
    [RaisesException] void send(Blob data);
    [RaisesException] void send(ArrayBuffer data);
    [RaisesException] void send(ArrayBufferView data);

    // Non-standard APIs
    [Measure] readonly attribute boolean reliable;
};