modules/websockets/WebSocket.idl

/*
 * Copyright (C) 2009 Google Inc.  All rights reserved.
 * Copyright (C) 2010, 2011 Apple 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * OWNER OR 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.
 */

// http://dev.w3.org/html5/websockets/#websocket
// http://www.whatwg.org/specs/web-apps/current-work/multipage/network.html#websocket

// FIXME: use BinaryType in binaryType
enum BinaryType { "blob", "arraybuffer" };

[
    ActiveDOMObject,
    // FIXME: should be optional union type http://crbug.com/240176
    Constructor(DOMString url),
    Constructor(DOMString url, DOMString protocol),
    Constructor(DOMString url, sequence<DOMString> protocols),
    ConstructorCallWith=ExecutionContext,
    Exposed=Window&Worker,
    RaisesException=Constructor,
    WillBeGarbageCollected,
] interface WebSocket : EventTarget {
    [MeasureAs=WebSocketURL] readonly attribute DOMString URL; // Lowercased .url is the one in the spec, but leaving .URL for compatibility reasons.
    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;
    [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString extensions;
    [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString protocol;
    [RaisesException] void close([Clamp] optional unsigned short code, optional DOMString reason);

    // messaging
             attribute EventHandler onmessage;
             attribute DOMString binaryType;
    [RaisesException] void send(DOMString data);
    [RaisesException] void send(Blob data);
    [RaisesException] void send(ArrayBuffer data);
    [RaisesException] void send(ArrayBufferView data);
};