Home | History | Annotate | Download | only in websockets 
      1 /*
      2  * Copyright (C) 2009 Google Inc.  All rights reserved.
      3  * Copyright (C) 2010 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 module websockets {
     33 
     34     interface [
     35         Conditional=WEB_SOCKETS,
     36         CanBeConstructed,
     37         CustomConstructFunction,
     38         ConstructorParameters=1,
     39         V8CustomConstructor,
     40         EventTarget,
     41         NoStaticTables
     42     ] WebSocket {
     43         readonly attribute DOMString URL;
     44 
     45         // ready state
     46         const unsigned short CONNECTING = 0;
     47         const unsigned short OPEN = 1;
     48         const unsigned short CLOSED = 2;
     49         readonly attribute unsigned short readyState;
     50 
     51         readonly attribute unsigned long bufferedAmount;
     52 
     53         // networking
     54         attribute EventListener onopen;
     55         attribute EventListener onmessage;
     56         attribute EventListener onerror;
     57         attribute EventListener onclose;
     58 
     59         [RequiresAllArguments] boolean send(in DOMString data) raises(DOMException);
     60         void close();
     61 
     62         // EventTarget interface
     63         void addEventListener(in DOMString type,
     64                               in EventListener listener,
     65                               in boolean useCapture);
     66         void removeEventListener(in DOMString type,
     67                                  in EventListener listener,
     68                                  in boolean useCapture);
     69         boolean dispatchEvent(in Event evt)
     70             raises(EventException);
     71     };
     72 }
     73