WebCore/dom/MessagePort.idl

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  */
  26
  27 module events {
  28
  29     interface [
  30         CustomMarkFunction,
  31         GenerateConstructor,
  32         NoStaticTables
  33     ] MessagePort {
  34 // We need to have something as an ObjC binding, because MessagePort is used in MessageEvent, which already has one,
  35 // but we don't want to actually expose the API while it is in flux.
  36 #if defined(LANGUAGE_JAVASCRIPT)
  37         readonly attribute boolean active;
  38         void postMessage(in DOMString message, in [Optional] MessagePort messagePort)
  39             raises(DOMException);
  40         [Custom] MessagePort startConversation(in DOMString message);
  41         void start();
  42         void close();
  43
  44         // event handler attributes
  45         attribute EventListener onmessage;
  46         attribute EventListener onclose;
  47
  48         // EventTarget interface
  49         [Custom] void addEventListener(in DOMString type,
  50                                        in EventListener listener,
  51                                        in boolean useCapture);
  52         [Custom] void removeEventListener(in DOMString type,
  53                                           in EventListener listener,
  54                                           in boolean useCapture);
  55         boolean dispatchEvent(in Event evt)
  56             raises(EventException);
  57 #endif
  58     };
  59
  60 }