code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/dom/MessagePort.h

   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 #ifndef MessagePort_h
  28 #define MessagePort_h
  29
  30 #include "EventListener.h"
  31 #include "EventTarget.h"
  32 #include "MessagePortChannel.h"
  33 #include <wtf/Forward.h>
  34 #include <wtf/OwnPtr.h>
  35 #include <wtf/PassOwnPtr.h>
  36 #include <wtf/PassRefPtr.h>
  37 #include <wtf/RefPtr.h>
  38 #include <wtf/Vector.h>
  39 #include <wtf/text/AtomicStringHash.h>
  40
  41 namespace WebCore {
  42
  43     class Event;
  44     class Frame;
  45     class MessagePort;
  46     class ScriptExecutionContext;
  47
  48     // The overwhelmingly common case is sending a single port, so handle that efficiently with an inline buffer of size 1.
  49     typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
  50
  51     // FIXME: This class should inherit from ActiveDOMObject and use
  52     // setPendingActivity / unsetPendingActivity instead of duplicating
  53     // ActiveDOMObject's features and relying on JavaScript garbage collection
  54     // to get its lifetime right.
  55     class MessagePort : public RefCounted<MessagePort>, public EventTarget {
  56     public:
  57         static PassRefPtr<MessagePort> create(ScriptExecutionContext& scriptExecutionContext) { return adoptRef(new MessagePort(scriptExecutionContext)); }
  58         ~MessagePort();
  59
  60         void postMessage(PassRefPtr<SerializedScriptValue> message, ExceptionCode&);
  61         void postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray*, ExceptionCode&);
  62         // FIXME: remove this when we update the ObjC bindings (bug #28774).
  63         void postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort*, ExceptionCode&);
  64
  65         void start();
  66         void close();
  67
  68         void entangle(PassOwnPtr<MessagePortChannel>);
  69         PassOwnPtr<MessagePortChannel> disentangle(ExceptionCode&);
  70
  71         // Disentangle an array of ports, returning the entangled channels.
  72         // Per section 8.3.3 of the HTML5 spec, generates an INVALID_STATE_ERR exception if any of the passed ports are null or not entangled.
  73         // Returns 0 if there is an exception, or if the passed-in array is 0/empty.
  74         static PassOwnPtr<MessagePortChannelArray> disentanglePorts(const MessagePortArray*, ExceptionCode&);
  75
  76         // Entangles an array of channels, returning an array of MessagePorts in matching order.
  77         // Returns 0 if the passed array is 0/empty.
  78         static PassOwnPtr<MessagePortArray> entanglePorts(ScriptExecutionContext&, PassOwnPtr<MessagePortChannelArray>);
  79
  80         void messageAvailable();
  81         bool started() const { return m_started; }
  82
  83         void contextDestroyed();
  84
  85         virtual ScriptExecutionContext* scriptExecutionContext() const;
  86
  87         virtual MessagePort* toMessagePort() { return this; }
  88
  89         void dispatchMessages();
  90
  91         using RefCounted<MessagePort>::ref;
  92         using RefCounted<MessagePort>::deref;
  93
  94         bool hasPendingActivity();
  95
  96         void setOnmessage(PassRefPtr<EventListener> listener)
  97         {
  98             setAttributeEventListener(eventNames().messageEvent, listener);
  99             start();
 100         }
 101         EventListener* onmessage() { return getAttributeEventListener(eventNames().messageEvent); }
 102
 103         // Returns null if there is no entangled port, or if the entangled port is run by a different thread.
 104         // Returns null otherwise.
 105         // NOTE: This is used solely to enable a GC optimization. Some platforms may not be able to determine ownership of the remote port (since it may live cross-process) - those platforms may always return null.
 106         MessagePort* locallyEntangledPort();
 107         // A port starts out its life entangled, and remains entangled until it is closed or is cloned.
 108         bool isEntangled() { return !m_closed && !isCloned(); }
 109         // A port is cloned if its entangled channel has been removed and sent to a new owner via postMessage().
 110         bool isCloned() { return !m_entangledChannel; }
 111
 112     private:
 113         MessagePort(ScriptExecutionContext&);
 114
 115         virtual void refEventTarget() { ref(); }
 116         virtual void derefEventTarget() { deref(); }
 117         virtual EventTargetData* eventTargetData();
 118         virtual EventTargetData* ensureEventTargetData();
 119
 120         OwnPtr<MessagePortChannel> m_entangledChannel;
 121
 122         bool m_started;
 123         bool m_closed;
 124
 125         ScriptExecutionContext* m_scriptExecutionContext;
 126         EventTargetData m_eventTargetData;
 127     };
 128
 129 } // namespace WebCore
 130
 131 #endif // MessagePort_h