Home | History | Annotate | Download | only in websockets 
      1 /*
      2  * Copyright (C) 2009 Google Inc.  All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 module websockets {
     32 
     33     interface [
     34         Conditional=WEB_SOCKETS,
     35         CustomConstructor,
     36         EventTarget,
     37         NoStaticTables
     38     ] WebSocket {
     39         readonly attribute DOMString URL;
     40 
     41         // ready state
     42         const unsigned short CONNECTING = 0;
     43         const unsigned short OPEN = 1;
     44         const unsigned short CLOSED = 2;
     45         readonly attribute unsigned short readyState;
     46 
     47         readonly attribute unsigned long bufferedAmount;
     48 
     49         // networking
     50         attribute EventListener onopen;
     51         attribute EventListener onmessage;
     52         attribute EventListener onclose;
     53 
     54         [Custom] boolean send(in DOMString data)
     55           raises(DOMException);
     56         void close();
     57 
     58         // EventTarget interface
     59         [Custom] void addEventListener(in DOMString type,
     60                                        in EventListener listener,
     61                                        in boolean useCapture);
     62         [Custom] void removeEventListener(in DOMString type,
     63                                           in EventListener listener,
     64                                           in boolean useCapture);
     65         boolean dispatchEvent(in Event evt)
     66             raises(EventException);
     67     };
     68 }
     69