src/third_party/WebKit/Source/modules/websockets/WebSocket.idl

   1 /*
   2  * Copyright (C) 2009 Google Inc.  All rights reserved.
   3  * Copyright (C) 2010, 2011 Apple Inc. All Rights Reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 // http://dev.w3.org/html5/websockets/#websocket
  33 // http://www.whatwg.org/specs/web-apps/current-work/multipage/network.html#websocket
  34
  35 // FIXME: use BinaryType in binaryType
  36 enum BinaryType { "blob", "arraybuffer" };
  37
  38 [
  39     ActiveDOMObject,
  40     // FIXME: should be optional union type http://crbug.com/240176
  41     Constructor(DOMString url, optional DOMString protocol),
  42     Constructor(DOMString url, sequence<DOMString> protocols),
  43     ConstructorCallWith=ExecutionContext,
  44     Exposed=(Window,Worker),
  45     RaisesException=Constructor,
  46     GarbageCollected,
  47     ImplementedAs=DOMWebSocket,
  48 ] interface WebSocket : EventTarget {
  49     [DeprecateAs=WebSocketURL] readonly attribute DOMString URL; // Lowercased .url is the one in the spec, but leaving .URL for compatibility reasons.
  50     readonly attribute DOMString url;
  51
  52     // ready state
  53     const unsigned short CONNECTING = 0;
  54     const unsigned short OPEN = 1;
  55     const unsigned short CLOSING = 2;
  56     const unsigned short CLOSED = 3;
  57     readonly attribute unsigned short readyState;
  58     readonly attribute unsigned long bufferedAmount;
  59
  60     // networking
  61              attribute EventHandler onopen;
  62              attribute EventHandler onerror;
  63              attribute EventHandler onclose;
  64     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString extensions;
  65     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString protocol;
  66     [RaisesException] void close([Clamp] optional unsigned short code, optional DOMString reason);
  67
  68     // messaging
  69              attribute EventHandler onmessage;
  70              attribute DOMString binaryType;
  71     [RaisesException] void send(DOMString data);
  72     [RaisesException] void send(Blob data);
  73     [RaisesException] void send(ArrayBuffer data);
  74     [RaisesException] void send(ArrayBufferView data);
  75 };