1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
/*
* Copyright (C) 2008 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#pragma once
#include <WebCore/ActiveDOMObject.h>
#include <WebCore/EventTarget.h>
#include <WebCore/EventTargetInterfaces.h>
#include <WebCore/MessagePortChannel.h>
#include <WebCore/MessagePortIdentifier.h>
#include <WebCore/MessageWithMessagePorts.h>
#include <wtf/WeakPtr.h>
namespace JSC {
class CallFrame;
class JSObject;
class JSValue;
}
namespace WebCore {
class LocalFrame;
class WebCoreOpaqueRoot;
struct StructuredSerializeOptions;
template<typename> class ExceptionOr;
class MessagePort final : public ActiveDOMObject, public EventTarget, public ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr<MessagePort> {
WTF_MAKE_NONCOPYABLE(MessagePort);
WTF_MAKE_TZONE_ALLOCATED_EXPORT(MessagePort, WEBCORE_EXPORT);
public:
static Ref<MessagePort> create(ScriptExecutionContext&, const MessagePortIdentifier& local, const MessagePortIdentifier& remote);
WEBCORE_EXPORT virtual ~MessagePort();
// ActiveDOMObject.
void ref() const final { ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr::ref(); }
void deref() const final { ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr::deref(); }
USING_CAN_MAKE_WEAKPTR(EventTarget);
ExceptionOr<void> postMessage(JSC::JSGlobalObject&, JSC::JSValue message, StructuredSerializeOptions&&);
void start();
void close();
void entangle();
// Returns nullptr if the passed-in vector is empty.
static ExceptionOr<Vector<TransferredMessagePort>> disentanglePorts(Vector<Ref<MessagePort>>&&);
static Vector<Ref<MessagePort>> entanglePorts(ScriptExecutionContext&, Vector<TransferredMessagePort>&&);
WEBCORE_EXPORT static bool isMessagePortAliveForTesting(const MessagePortIdentifier&);
WEBCORE_EXPORT static void notifyMessageAvailable(const MessagePortIdentifier&);
WEBCORE_EXPORT void messageAvailable();
bool started() const { return m_started; }
bool isDetached() const { return m_isDetached; }
void dispatchMessages();
// Returns null if there is no entangled port, or if the entangled port is run by a different thread.
// 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.
MessagePort* locallyEntangledPort() const;
const MessagePortIdentifier& identifier() const { return m_identifier; }
const MessagePortIdentifier& remoteIdentifier() const { return m_remoteIdentifier; }
// EventTarget.
enum EventTargetInterfaceType eventTargetInterface() const final { return EventTargetInterfaceType::MessagePort; }
ScriptExecutionContext* scriptExecutionContext() const final;
using ActiveDOMObject::protectedScriptExecutionContext;
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
void dispatchEvent(Event&) final;
TransferredMessagePort disentangle();
static Ref<MessagePort> entangle(ScriptExecutionContext&, TransferredMessagePort&&);
private:
MessagePort(ScriptExecutionContext&, const MessagePortIdentifier& local, const MessagePortIdentifier& remote);
bool addEventListener(const AtomString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) final;
bool removeEventListener(const AtomString& eventType, EventListener&, const EventListenerOptions&) final;
// ActiveDOMObject.
void contextDestroyed() final;
void stop() final { close(); }
bool virtualHasPendingActivity() const final;
// A port starts out its life entangled, and remains entangled until it is detached or is cloned.
bool isEntangled() const { return !m_isDetached && m_entangled; }
bool m_started { false };
bool m_isDetached { false };
bool m_entangled { true };
bool m_hasMessageEventListener { false };
MessagePortIdentifier m_identifier;
MessagePortIdentifier m_remoteIdentifier;
};
WebCoreOpaqueRoot root(MessagePort*);
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_EVENTTARGET(MessagePort)
|