Move some more assorted classes from ExceptionCode to Exception
[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 "EventTarget.h"
30 #include "ExceptionOr.h"
31 #include "MessagePortChannel.h"
32
33 namespace WebCore {
34
35 class Frame;
36
37 class MessagePort final : public RefCounted<MessagePort>, public EventTargetWithInlineData {
38 public:
39     static Ref<MessagePort> create(ScriptExecutionContext& scriptExecutionContext) { return adoptRef(*new MessagePort(scriptExecutionContext)); }
40     virtual ~MessagePort();
41
42     ExceptionOr<void> postMessage(RefPtr<SerializedScriptValue>&& message, Vector<RefPtr<MessagePort>>&&);
43
44     void start();
45     void close();
46
47     void entangle(std::unique_ptr<MessagePortChannel>&&);
48
49     // Returns nullptr if the passed-in vector is empty.
50     static ExceptionOr<std::unique_ptr<MessagePortChannelArray>> disentanglePorts(Vector<RefPtr<MessagePort>>&&);
51
52     static Vector<RefPtr<MessagePort>> entanglePorts(ScriptExecutionContext&, std::unique_ptr<MessagePortChannelArray>&&);
53
54     void messageAvailable();
55     bool started() const { return m_started; }
56
57     void contextDestroyed();
58
59     ScriptExecutionContext* scriptExecutionContext() const final { return m_scriptExecutionContext; }
60
61     void dispatchMessages();
62
63     bool hasPendingActivity();
64
65     // Returns null if there is no entangled port, or if the entangled port is run by a different thread.
66     // This is used solely to enable a GC optimization. Some platforms may not be able to determine ownership
67     // of the remote port (since it may live cross-process) - those platforms may always return null.
68     MessagePort* locallyEntangledPort();
69
70     using RefCounted::ref;
71     using RefCounted::deref;
72
73 private:
74     explicit MessagePort(ScriptExecutionContext&);
75
76     void refEventTarget() final { ref(); }
77     void derefEventTarget() final { deref(); }
78
79     bool isMessagePort() const final { return true; }
80     EventTargetInterface eventTargetInterface() const final { return MessagePortEventTargetInterfaceType; }
81
82     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) final;
83
84     std::unique_ptr<MessagePortChannel> disentangle();
85
86     // A port starts out its life entangled, and remains entangled until it is closed or is cloned.
87     bool isEntangled() const { return !m_closed && !isNeutered(); }
88
89     // A port gets neutered when it is transferred to a new owner via postMessage().
90     bool isNeutered() const { return !m_entangledChannel; }
91
92     std::unique_ptr<MessagePortChannel> m_entangledChannel;
93     bool m_started { false };
94     bool m_closed { false };
95     ScriptExecutionContext* m_scriptExecutionContext;
96 };
97
98 } // namespace WebCore