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