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