Home | History | Annotate | Download | only in websockets
      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 [
     33     ActiveDOMObject,
     34     Constructor(DOMString url),
     35     Constructor(DOMString url, sequence<DOMString> protocols),
     36     Constructor(DOMString url, DOMString protocol),
     37     ConstructorCallWith=ExecutionContext,
     38     GlobalContext=Window&WorkerGlobalScope,
     39     RaisesException=Constructor,
     40 ] interface WebSocket : EventTarget {
     41     readonly attribute DOMString URL; // Lowercased .url is the one in the spec, but leaving .URL for compatibility reasons.
     42     readonly attribute DOMString url;
     43 
     44     // ready state
     45     const unsigned short CONNECTING = 0;
     46     const unsigned short OPEN = 1;
     47     const unsigned short CLOSING = 2;
     48     const unsigned short CLOSED = 3;
     49     readonly attribute unsigned short readyState;
     50 
     51     readonly attribute unsigned long bufferedAmount;
     52 
     53     // networking
     54     attribute EventHandler onopen;
     55     attribute EventHandler onmessage;
     56     attribute EventHandler onerror;
     57     attribute EventHandler onclose;
     58 
     59     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString protocol;
     60     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString extensions;
     61 
     62     attribute DOMString binaryType;
     63 
     64     [RaisesException] void send(ArrayBuffer data);
     65     [RaisesException] void send(ArrayBufferView data);
     66     [RaisesException] void send(Blob data);
     67     [RaisesException] void send(DOMString data);
     68 
     69     [RaisesException] void close([Clamp] optional unsigned short code, optional DOMString reason);
     70 };
     71