Identify MessagePorts by a globally unique MessagePortIdentifier.
[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
35 namespace JSC {
36 class ExecState;
37 class JSObject;
38 class JSValue;
39 }
40
41 namespace WebCore {
42
43 class Frame;
44
45 class MessagePort final : public ActiveDOMObject, public EventTargetWithInlineData {
46 public:
47     static Ref<MessagePort> create(ScriptExecutionContext& scriptExecutionContext, const MessagePortIdentifier& identifier) { return adoptRef(*new MessagePort(scriptExecutionContext, identifier)); }
48     virtual ~MessagePort();
49
50     ExceptionOr<void> postMessage(JSC::ExecState&, JSC::JSValue message, Vector<JSC::Strong<JSC::JSObject>>&&);
51
52     void start();
53     void close();
54
55     void entangleWithRemote(RefPtr<MessagePortChannel>&&);
56
57     // Returns nullptr if the passed-in vector is empty.
58     static ExceptionOr<std::unique_ptr<MessagePortChannelArray>> disentanglePorts(Vector<RefPtr<MessagePort>>&&);
59     static Vector<RefPtr<MessagePort>> entanglePorts(ScriptExecutionContext&, std::unique_ptr<MessagePortChannelArray>&&);
60     static RefPtr<MessagePort> existingMessagePortForIdentifier(const MessagePortIdentifier&);
61
62     void messageAvailable();
63     bool started() const { return m_started; }
64
65     void dispatchMessages();
66
67     // Returns null if there is no entangled port, or if the entangled port is run by a different thread.
68     // This is used solely to enable a GC optimization. Some platforms may not be able to determine ownership
69     // of the remote port (since it may live cross-process) - those platforms may always return null.
70     MessagePort* locallyEntangledPort() const;
71
72     const MessagePortIdentifier& identifier() const { return m_identifier; }
73
74     void ref() const;
75     void deref() const;
76
77     // ActiveDOMObject
78     const char* activeDOMObjectName() const final;
79     bool canSuspendForDocumentSuspension() const final;
80     void contextDestroyed() final;
81     void stop() final { close(); }
82     bool hasPendingActivity() const final;
83
84     // EventTargetWithInlineData.
85     EventTargetInterface eventTargetInterface() const final { return MessagePortEventTargetInterfaceType; }
86     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
87     void refEventTarget() final { ref(); }
88     void derefEventTarget() final { deref(); }
89
90 private:
91     explicit MessagePort(ScriptExecutionContext&, const MessagePortIdentifier&);
92
93     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) final;
94
95     RefPtr<MessagePortChannel> disentangle();
96
97     // A port starts out its life entangled, and remains entangled until it is closed or is cloned.
98     bool isEntangled() const { return !m_closed && !isNeutered(); }
99
100     // A port gets neutered when it is transferred to a new owner via postMessage().
101     bool isNeutered() const { return !m_entangledChannel; }
102
103     RefPtr<MessagePortChannel> m_entangledChannel;
104     RefPtr<MessagePort> m_messageProtector;
105     bool m_started { false };
106     bool m_closed { false };
107
108     MessagePortIdentifier m_identifier;
109
110     mutable std::atomic<unsigned> m_refCount { 1 };
111 };
112
113 } // namespace WebCore