Clean up ScriptExecutionContext::Task and subclasses
[WebKit-https.git] / Source / WebCore / Modules / websockets / ThreadableWebSocketChannelClientWrapper.cpp
1 /*
2  * Copyright (C) 2011 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 #include "config.h"
32 #if ENABLE(WEB_SOCKETS) && ENABLE(WORKERS)
33 #include "ThreadableWebSocketChannelClientWrapper.h"
34
35 #include "CrossThreadCopier.h"
36 #include "CrossThreadTask.h"
37 #include "ScriptExecutionContext.h"
38 #include "WebSocketChannelClient.h"
39 #include <wtf/PassRefPtr.h>
40 #include <wtf/RefPtr.h>
41
42 namespace WebCore {
43
44 ThreadableWebSocketChannelClientWrapper::ThreadableWebSocketChannelClientWrapper(ScriptExecutionContext* context, WebSocketChannelClient* client)
45     : m_context(context)
46     , m_client(client)
47     , m_peer(0)
48     , m_failedWebSocketChannelCreation(false)
49     , m_syncMethodDone(true)
50     , m_sendRequestResult(ThreadableWebSocketChannel::SendFail)
51     , m_bufferedAmount(0)
52     , m_suspended(false)
53 {
54 }
55
56 PassRefPtr<ThreadableWebSocketChannelClientWrapper> ThreadableWebSocketChannelClientWrapper::create(ScriptExecutionContext* context, WebSocketChannelClient* client)
57 {
58     return adoptRef(new ThreadableWebSocketChannelClientWrapper(context, client));
59 }
60
61 void ThreadableWebSocketChannelClientWrapper::clearSyncMethodDone()
62 {
63     m_syncMethodDone = false;
64 }
65
66 void ThreadableWebSocketChannelClientWrapper::setSyncMethodDone()
67 {
68     m_syncMethodDone = true;
69 }
70
71 bool ThreadableWebSocketChannelClientWrapper::syncMethodDone() const
72 {
73     return m_syncMethodDone;
74 }
75
76 WorkerThreadableWebSocketChannel::Peer* ThreadableWebSocketChannelClientWrapper::peer() const
77 {
78     return m_peer;
79 }
80
81 void ThreadableWebSocketChannelClientWrapper::didCreateWebSocketChannel(WorkerThreadableWebSocketChannel::Peer* peer)
82 {
83     m_peer = peer;
84     m_syncMethodDone = true;
85 }
86
87 void ThreadableWebSocketChannelClientWrapper::clearPeer()
88 {
89     m_peer = 0;
90 }
91
92 bool ThreadableWebSocketChannelClientWrapper::failedWebSocketChannelCreation() const
93 {
94     return m_failedWebSocketChannelCreation;
95 }
96
97 void ThreadableWebSocketChannelClientWrapper::setFailedWebSocketChannelCreation()
98 {
99     m_failedWebSocketChannelCreation = true;
100 }
101
102 String ThreadableWebSocketChannelClientWrapper::subprotocol() const
103 {
104     if (m_subprotocol.isEmpty())
105         return emptyString();
106     return String(m_subprotocol);
107 }
108
109 void ThreadableWebSocketChannelClientWrapper::setSubprotocol(const String& subprotocol)
110 {
111     unsigned length = subprotocol.length();
112     m_subprotocol.resize(length);
113     if (length)
114         memcpy(m_subprotocol.data(), subprotocol.characters(), sizeof(UChar) * length);
115 }
116
117 String ThreadableWebSocketChannelClientWrapper::extensions() const
118 {
119     if (m_extensions.isEmpty())
120         return emptyString();
121     return String(m_extensions);
122 }
123
124 void ThreadableWebSocketChannelClientWrapper::setExtensions(const String& extensions)
125 {
126     unsigned length = extensions.length();
127     m_extensions.resize(length);
128     if (length)
129         memcpy(m_extensions.data(), extensions.characters(), sizeof(UChar) * length);
130 }
131
132 ThreadableWebSocketChannel::SendResult ThreadableWebSocketChannelClientWrapper::sendRequestResult() const
133 {
134     return m_sendRequestResult;
135 }
136
137 void ThreadableWebSocketChannelClientWrapper::setSendRequestResult(ThreadableWebSocketChannel::SendResult sendRequestResult)
138 {
139     m_sendRequestResult = sendRequestResult;
140     m_syncMethodDone = true;
141 }
142
143 unsigned long ThreadableWebSocketChannelClientWrapper::bufferedAmount() const
144 {
145     return m_bufferedAmount;
146 }
147
148 void ThreadableWebSocketChannelClientWrapper::setBufferedAmount(unsigned long bufferedAmount)
149 {
150     m_bufferedAmount = bufferedAmount;
151     m_syncMethodDone = true;
152 }
153
154 void ThreadableWebSocketChannelClientWrapper::clearClient()
155 {
156     m_client = 0;
157 }
158
159 void ThreadableWebSocketChannelClientWrapper::didConnect()
160 {
161     m_pendingTasks.append(createCallbackTask(&didConnectCallback, this));
162     if (!m_suspended)
163         processPendingTasks();
164 }
165
166 void ThreadableWebSocketChannelClientWrapper::didReceiveMessage(const String& message)
167 {
168     m_pendingTasks.append(createCallbackTask(&didReceiveMessageCallback, this, message));
169     if (!m_suspended)
170         processPendingTasks();
171 }
172
173 void ThreadableWebSocketChannelClientWrapper::didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData)
174 {
175     m_pendingTasks.append(createCallbackTask(&didReceiveBinaryDataCallback, this, binaryData));
176     if (!m_suspended)
177         processPendingTasks();
178 }
179
180 void ThreadableWebSocketChannelClientWrapper::didUpdateBufferedAmount(unsigned long bufferedAmount)
181 {
182     m_pendingTasks.append(createCallbackTask(&didUpdateBufferedAmountCallback, this, bufferedAmount));
183     if (!m_suspended)
184         processPendingTasks();
185 }
186
187 void ThreadableWebSocketChannelClientWrapper::didStartClosingHandshake()
188 {
189     m_pendingTasks.append(createCallbackTask(&didStartClosingHandshakeCallback, this));
190     if (!m_suspended)
191         processPendingTasks();
192 }
193
194 void ThreadableWebSocketChannelClientWrapper::didClose(unsigned long unhandledBufferedAmount, WebSocketChannelClient::ClosingHandshakeCompletionStatus closingHandshakeCompletion, unsigned short code, const String& reason)
195 {
196     m_pendingTasks.append(createCallbackTask(&didCloseCallback, this, unhandledBufferedAmount, closingHandshakeCompletion, code, reason));
197     if (!m_suspended)
198         processPendingTasks();
199 }
200
201 void ThreadableWebSocketChannelClientWrapper::didReceiveMessageError()
202 {
203     m_pendingTasks.append(createCallbackTask(&didReceiveMessageErrorCallback, this));
204     if (!m_suspended)
205         processPendingTasks();
206 }
207
208 void ThreadableWebSocketChannelClientWrapper::suspend()
209 {
210     m_suspended = true;
211 }
212
213 void ThreadableWebSocketChannelClientWrapper::resume()
214 {
215     m_suspended = false;
216     processPendingTasks();
217 }
218
219 void ThreadableWebSocketChannelClientWrapper::processPendingTasksCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper)
220 {
221     ASSERT_UNUSED(context, context->isWorkerGlobalScope());
222     wrapper->processPendingTasks();
223 }
224
225 void ThreadableWebSocketChannelClientWrapper::processPendingTasks()
226 {
227     if (m_suspended)
228         return;
229     if (!m_syncMethodDone) {
230         // When a synchronous operation is in progress (i.e. the execution stack contains
231         // WorkerThreadableWebSocketChannel::waitForMethodCompletion()), we cannot invoke callbacks in this run loop.
232         m_context->postTask(createCallbackTask(&ThreadableWebSocketChannelClientWrapper::processPendingTasksCallback, this));
233         return;
234     }
235
236     auto tasks = std::move(m_pendingTasks);
237
238     for (auto iter = tasks.begin(); iter != tasks.end(); ++iter)
239         (*iter)->performTask(0);
240 }
241
242 void ThreadableWebSocketChannelClientWrapper::didConnectCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper)
243 {
244     ASSERT_UNUSED(context, !context);
245     if (wrapper->m_client)
246         wrapper->m_client->didConnect();
247 }
248
249 void ThreadableWebSocketChannelClientWrapper::didReceiveMessageCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper, const String& message)
250 {
251     ASSERT_UNUSED(context, !context);
252     if (wrapper->m_client)
253         wrapper->m_client->didReceiveMessage(message);
254 }
255
256 void ThreadableWebSocketChannelClientWrapper::didReceiveBinaryDataCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper, PassOwnPtr<Vector<char> > binaryData)
257 {
258     ASSERT_UNUSED(context, !context);
259     if (wrapper->m_client)
260         wrapper->m_client->didReceiveBinaryData(binaryData);
261 }
262
263 void ThreadableWebSocketChannelClientWrapper::didUpdateBufferedAmountCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper, unsigned long bufferedAmount)
264 {
265     ASSERT_UNUSED(context, !context);
266     if (wrapper->m_client)
267         wrapper->m_client->didUpdateBufferedAmount(bufferedAmount);
268 }
269
270 void ThreadableWebSocketChannelClientWrapper::didStartClosingHandshakeCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper)
271 {
272     ASSERT_UNUSED(context, !context);
273     if (wrapper->m_client)
274         wrapper->m_client->didStartClosingHandshake();
275 }
276
277 void ThreadableWebSocketChannelClientWrapper::didCloseCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper, unsigned long unhandledBufferedAmount, WebSocketChannelClient::ClosingHandshakeCompletionStatus closingHandshakeCompletion, unsigned short code, const String& reason)
278 {
279     ASSERT_UNUSED(context, !context);
280     if (wrapper->m_client)
281         wrapper->m_client->didClose(unhandledBufferedAmount, closingHandshakeCompletion, code, reason);
282 }
283
284 void ThreadableWebSocketChannelClientWrapper::didReceiveMessageErrorCallback(ScriptExecutionContext* context, PassRefPtr<ThreadableWebSocketChannelClientWrapper> wrapper)
285 {
286     ASSERT_UNUSED(context, !context);
287     if (wrapper->m_client)
288         wrapper->m_client->didReceiveMessageError();
289 }
290
291 } // namespace WebCore
292
293 #endif