Deprecate ActiveDOMObject::canSuspendForDocumentSuspension()
[WebKit-https.git] / 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 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 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 #pragma once
28
29 #include "ActiveDOMObject.h"
30 #include "EventTarget.h"
31 #include "ExceptionOr.h"
32 #include "GenericEventQueue.h"
33 #include "MessagePortChannel.h"
34 #include "MessagePortIdentifier.h"
35 #include "MessageWithMessagePorts.h"
36 #include <wtf/WeakPtr.h>
37
38 namespace JSC {
39 class CallFrame;
40 class JSObject;
41 class JSValue;
42 using ExecState = CallFrame;
43 }
44
45 namespace WebCore {
46
47 class Frame;
48
49 class MessagePort final : public ActiveDOMObject, public EventTargetWithInlineData, public CanMakeWeakPtr<MessagePort, WeakPtrFactoryInitialization::Eager> {
50     WTF_MAKE_NONCOPYABLE(MessagePort);
51     WTF_MAKE_ISO_ALLOCATED(MessagePort);
52 public:
53     static Ref<MessagePort> create(ScriptExecutionContext&, const MessagePortIdentifier& local, const MessagePortIdentifier& remote);
54     virtual ~MessagePort();
55
56     ExceptionOr<void> postMessage(JSC::ExecState&, JSC::JSValue message, Vector<JSC::Strong<JSC::JSObject>>&&);
57
58     void start();
59     void close();
60     void entangle();
61
62     // Returns nullptr if the passed-in vector is empty.
63     static ExceptionOr<TransferredMessagePortArray> disentanglePorts(Vector<RefPtr<MessagePort>>&&);
64     static Vector<RefPtr<MessagePort>> entanglePorts(ScriptExecutionContext&, TransferredMessagePortArray&&);
65
66     WEBCORE_EXPORT static bool isExistingMessagePortLocallyReachable(const MessagePortIdentifier&);
67     WEBCORE_EXPORT static void notifyMessageAvailable(const MessagePortIdentifier&);
68
69     WEBCORE_EXPORT void messageAvailable();
70     bool started() const { return m_started; }
71     bool closed() const { return m_closed; }
72
73     void dispatchMessages();
74
75     // Returns null if there is no entangled port, or if the entangled port is run by a different thread.
76     // This is used solely to enable a GC optimization. Some platforms may not be able to determine ownership
77     // of the remote port (since it may live cross-process) - those platforms may always return null.
78     MessagePort* locallyEntangledPort() const;
79
80     const MessagePortIdentifier& identifier() const { return m_identifier; }
81     const MessagePortIdentifier& remoteIdentifier() const { return m_remoteIdentifier; }
82
83     WEBCORE_EXPORT void ref() const;
84     WEBCORE_EXPORT void deref() const;
85
86     // ActiveDOMObject
87     const char* activeDOMObjectName() const final;
88     void contextDestroyed() final;
89     void stop() final { close(); }
90     bool hasPendingActivity() const final;
91
92     WEBCORE_EXPORT bool isLocallyReachable() const;
93
94     // EventTargetWithInlineData.
95     EventTargetInterface eventTargetInterface() const final { return MessagePortEventTargetInterfaceType; }
96     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
97     void refEventTarget() final { ref(); }
98     void derefEventTarget() final { deref(); }
99
100 private:
101     explicit MessagePort(ScriptExecutionContext&, const MessagePortIdentifier& local, const MessagePortIdentifier& remote);
102
103     bool addEventListener(const AtomString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) final;
104     bool removeEventListener(const AtomString& eventType, EventListener&, const ListenerOptions&) final;
105
106     void disentangle();
107
108     void registerLocalActivity();
109
110     // A port starts out its life entangled, and remains entangled until it is closed or is cloned.
111     bool isEntangled() const { return !m_closed && m_entangled; }
112
113     void updateActivity(MessagePortChannelProvider::HasActivity);
114
115     bool m_started { false };
116     bool m_closed { false };
117     bool m_entangled { true };
118
119     // Flags to manage querying the remote port for GC purposes
120     mutable bool m_mightBeEligibleForGC { false };
121     mutable bool m_hasHadLocalActivitySinceLastCheck { false };
122     mutable bool m_isRemoteEligibleForGC { false };
123     mutable bool m_isAskingRemoteAboutGC { false };
124     bool m_hasMessageEventListener { false };
125
126     MessagePortIdentifier m_identifier;
127     MessagePortIdentifier m_remoteIdentifier;
128
129     mutable std::atomic<unsigned> m_refCount { 1 };
130     UniqueRef<GenericEventQueue> m_eventQueue;
131 };
132
133 } // namespace WebCore