Reduce uses of PassRefPtr in WebCore/dom - 6
[WebKit-https.git] / Source / WebCore / dom / default / PlatformMessagePortChannel.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef PlatformMessagePortChannel_h
32 #define PlatformMessagePortChannel_h
33
34 #include "MessagePortChannel.h"
35
36 #include <wtf/MessageQueue.h>
37 #include <wtf/Threading.h>
38
39 namespace WebCore {
40
41     class MessagePort;
42
43     // PlatformMessagePortChannel is a platform-dependent interface to the remote side of a message channel.
44     // This default implementation supports multiple threads running within a single process. Implementations for multi-process platforms should define these public APIs in their own platform-specific PlatformMessagePortChannel file.
45     // The goal of this implementation is to eliminate contention except when cloning or closing the port, so each side of the channel has its own separate mutex.
46     class PlatformMessagePortChannel : public ThreadSafeRefCounted<PlatformMessagePortChannel> {
47     public:
48         class EventData {
49             WTF_MAKE_NONCOPYABLE(EventData); WTF_MAKE_FAST_ALLOCATED;
50         public:
51             EventData(RefPtr<SerializedScriptValue>&& message, std::unique_ptr<MessagePortChannelArray>);
52
53             RefPtr<SerializedScriptValue> message() { return m_message; }
54             std::unique_ptr<MessagePortChannelArray> channels() { return WTFMove(m_channels); }
55
56         private:
57             RefPtr<SerializedScriptValue> m_message;
58             std::unique_ptr<MessagePortChannelArray> m_channels;
59         };
60
61         // Wrapper for MessageQueue that allows us to do thread safe sharing by two proxies.
62         class MessagePortQueue : public ThreadSafeRefCounted<MessagePortQueue> {
63         public:
64             static Ref<MessagePortQueue> create() { return adoptRef(*new MessagePortQueue()); }
65
66             std::unique_ptr<PlatformMessagePortChannel::EventData> tryGetMessage()
67             {
68                 return m_queue.tryGetMessage();
69             }
70
71             bool appendAndCheckEmpty(std::unique_ptr<PlatformMessagePortChannel::EventData> message)
72             {
73                 return m_queue.appendAndCheckEmpty(WTFMove(message));
74             }
75
76             bool isEmpty()
77             {
78                 return m_queue.isEmpty();
79             }
80
81         private:
82             MessagePortQueue() { }
83
84             MessageQueue<PlatformMessagePortChannel::EventData> m_queue;
85         };
86
87         ~PlatformMessagePortChannel();
88
89         static Ref<PlatformMessagePortChannel> create(MessagePortQueue* incoming, MessagePortQueue* outgoing);
90         PlatformMessagePortChannel(MessagePortQueue* incoming, MessagePortQueue* outgoing);
91
92         RefPtr<PlatformMessagePortChannel> entangledChannel();
93
94         void setRemotePort(MessagePort*);
95         void closeInternal();
96
97         // Lock used to ensure exclusive access to the object internals.
98         Lock m_mutex;
99
100         // Pointer to our entangled pair - cleared when close() is called.
101         RefPtr<PlatformMessagePortChannel> m_entangledChannel;
102
103         // Reference to the message queue for the (local) entangled port.
104         RefPtr<MessagePortQueue> m_incomingQueue;
105         RefPtr<MessagePortQueue> m_outgoingQueue;
106
107         // The port we are connected to (the remote port) - this is the port that is notified when new messages arrive.
108         MessagePort* m_remotePort { nullptr };
109     };
110
111 } // namespace WebCore
112
113 #endif // PlatformMessagePortChannel_h