code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/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 module websockets {
  33
  34     interface [
  35         Conditional=WEB_SOCKETS,
  36         ActiveDOMObject,
  37         CanBeConstructed,
  38         CustomConstructFunction,
  39         ConstructorParameters=1,
  40         V8CustomConstructor,
  41         EventTarget,
  42         NoStaticTables
  43     ] WebSocket {
  44         readonly attribute DOMString URL;
  45
  46         // ready state
  47         const unsigned short CONNECTING = 0;
  48         const unsigned short OPEN = 1;
  49         const unsigned short CLOSING = 2;
  50         const unsigned short CLOSED = 3;
  51         readonly attribute unsigned short readyState;
  52
  53         readonly attribute unsigned long bufferedAmount;
  54
  55         // networking
  56         attribute EventListener onopen;
  57         attribute EventListener onmessage;
  58         attribute EventListener onerror;
  59         attribute EventListener onclose;
  60
  61         readonly attribute [ConvertNullStringTo=Undefined] DOMString protocol;
  62
  63         attribute [ConvertNullStringTo=Undefined] DOMString binaryType
  64             setter raises(DOMException);
  65
  66         // FIXME: Use overloading provided by our IDL code generator.
  67         // According to Web IDL specification, overloaded function with DOMString argument
  68         // should accept anything that can be converted to a string (including numbers,
  69         // booleans, null, undefined and objects except ArrayBuffer and Blob). Current code
  70         // generator does not handle this rule correctly.
  71         // [RequiresAllArguments] boolean send(in ArrayBuffer data) raises(DOMException);
  72         // [RequiresAllArguments] boolean send(in Blob data) raises(DOMException);
  73         // [RequiresAllArguments] boolean send(in DOMString data) raises(DOMException);
  74         [Custom] boolean send(in DOMString data) raises(DOMException);
  75
  76         // FIXME: Implement and apply [Clamp] attribute instead of [Custom].
  77         [Custom] void close(in [Optional] unsigned short code, in [Optional] DOMString reason) raises(DOMException);
  78
  79         // EventTarget interface
  80         void addEventListener(in DOMString type,
  81                               in EventListener listener,
  82                               in [Optional] boolean useCapture);
  83         void removeEventListener(in DOMString type,
  84                                  in EventListener listener,
  85                                  in [Optional] boolean useCapture);
  86         boolean dispatchEvent(in Event evt)
  87             raises(EventException);
  88     };
  89 }