715b63acf90128c7d38a40c3c633df2c2895faf2
[WebKit-https.git] / Source / WebCore / Modules / websockets / WorkerThreadableWebSocketChannel.h
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 #ifndef WorkerThreadableWebSocketChannel_h
32 #define WorkerThreadableWebSocketChannel_h
33
34 #if ENABLE(WEB_SOCKETS) && ENABLE(WORKERS)
35
36 #include "PlatformString.h"
37 #include "ThreadableWebSocketChannel.h"
38 #include "WebSocketChannelClient.h"
39 #include "WorkerContext.h"
40
41 #include <wtf/PassRefPtr.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/RefPtr.h>
44 #include <wtf/Threading.h>
45
46 namespace WebCore {
47
48 class KURL;
49 class ScriptExecutionContext;
50 class ThreadableWebSocketChannelClientWrapper;
51 class WorkerContext;
52 class WorkerLoaderProxy;
53 class WorkerRunLoop;
54
55 class WorkerThreadableWebSocketChannel : public RefCounted<WorkerThreadableWebSocketChannel>, public ThreadableWebSocketChannel {
56     WTF_MAKE_FAST_ALLOCATED;
57 public:
58     static PassRefPtr<ThreadableWebSocketChannel> create(WorkerContext* workerContext, WebSocketChannelClient* client, const String& taskMode)
59     {
60         return adoptRef(new WorkerThreadableWebSocketChannel(workerContext, client, taskMode));
61     }
62     virtual ~WorkerThreadableWebSocketChannel();
63
64     // ThreadableWebSocketChannel functions.
65     virtual bool useHixie76Protocol() OVERRIDE;
66     virtual void connect(const KURL&, const String& protocol) OVERRIDE;
67     virtual String subprotocol() OVERRIDE;
68     virtual String extensions() OVERRIDE;
69     virtual ThreadableWebSocketChannel::SendResult send(const String& message) OVERRIDE;
70     virtual ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&) OVERRIDE;
71     virtual ThreadableWebSocketChannel::SendResult send(const Blob&) OVERRIDE;
72     virtual unsigned long bufferedAmount() const OVERRIDE;
73     virtual void close(int code, const String& reason) OVERRIDE;
74     virtual void fail(const String& reason) OVERRIDE;
75     virtual void disconnect() OVERRIDE; // Will suppress didClose().
76     virtual void suspend() OVERRIDE;
77     virtual void resume() OVERRIDE;
78
79     // Generated by the bridge.  The Peer and its bridge should have identical
80     // lifetimes.
81     class Peer : public WebSocketChannelClient {
82         WTF_MAKE_NONCOPYABLE(Peer); WTF_MAKE_FAST_ALLOCATED;
83     public:
84         static Peer* create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, ScriptExecutionContext* context, const String& taskMode)
85         {
86             return new Peer(clientWrapper, loaderProxy, context, taskMode);
87         }
88         ~Peer();
89
90         bool useHixie76Protocol();
91         void connect(const KURL&, const String& protocol);
92         void send(const String& message);
93         void send(const ArrayBuffer&);
94         void send(const Blob&);
95         void bufferedAmount();
96         void close(int code, const String& reason);
97         void fail(const String& reason);
98         void disconnect();
99         void suspend();
100         void resume();
101
102         // WebSocketChannelClient functions.
103         virtual void didConnect() OVERRIDE;
104         virtual void didReceiveMessage(const String& message) OVERRIDE;
105         virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> >) OVERRIDE;
106         virtual void didUpdateBufferedAmount(unsigned long bufferedAmount) OVERRIDE;
107         virtual void didStartClosingHandshake() OVERRIDE;
108         virtual void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) OVERRIDE;
109         virtual void didReceiveMessageError() OVERRIDE;
110
111     private:
112         Peer(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, WorkerLoaderProxy&, ScriptExecutionContext*, const String& taskMode);
113
114         RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
115         WorkerLoaderProxy& m_loaderProxy;
116         RefPtr<ThreadableWebSocketChannel> m_mainWebSocketChannel;
117         String m_taskMode;
118     };
119
120     using RefCounted<WorkerThreadableWebSocketChannel>::ref;
121     using RefCounted<WorkerThreadableWebSocketChannel>::deref;
122
123 protected:
124     virtual void refThreadableWebSocketChannel() { ref(); }
125     virtual void derefThreadableWebSocketChannel() { deref(); }
126
127 private:
128     // Bridge for Peer.  Running on the worker thread.
129     class Bridge : public RefCounted<Bridge> {
130     public:
131         static PassRefPtr<Bridge> create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, PassRefPtr<WorkerContext> workerContext, const String& taskMode)
132         {
133             return adoptRef(new Bridge(workerClientWrapper, workerContext, taskMode));
134         }
135         ~Bridge();
136         void initialize();
137         void connect(const KURL&, const String& protocol);
138         ThreadableWebSocketChannel::SendResult send(const String& message);
139         ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&);
140         ThreadableWebSocketChannel::SendResult send(const Blob&);
141         unsigned long bufferedAmount();
142         void close(int code, const String& reason);
143         void fail(const String& reason);
144         void disconnect();
145         void suspend();
146         void resume();
147
148         using RefCounted<Bridge>::ref;
149         using RefCounted<Bridge>::deref;
150
151     private:
152         Bridge(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, PassRefPtr<WorkerContext>, const String& taskMode);
153
154         static void setWebSocketChannel(ScriptExecutionContext*, Bridge* thisPtr, Peer*, PassRefPtr<ThreadableWebSocketChannelClientWrapper>, bool useHixie76Protocol);
155
156         // Executed on the main thread to create a Peer for this bridge.
157         static void mainThreadInitialize(ScriptExecutionContext*, WorkerLoaderProxy*, PassRefPtr<ThreadableWebSocketChannelClientWrapper>, const String& taskMode);
158
159         // Executed on the worker context's thread.
160         void clearClientWrapper();
161
162         void setMethodNotCompleted();
163         void waitForMethodCompletion();
164
165         RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
166         RefPtr<WorkerContext> m_workerContext;
167         WorkerLoaderProxy& m_loaderProxy;
168         String m_taskMode;
169         Peer* m_peer;
170     };
171
172     WorkerThreadableWebSocketChannel(WorkerContext*, WebSocketChannelClient*, const String& taskMode);
173
174     static void mainThreadConnect(ScriptExecutionContext*, Peer*, const KURL&, const String& protocol);
175     static void mainThreadSend(ScriptExecutionContext*, Peer*, const String& message);
176     static void mainThreadSendArrayBuffer(ScriptExecutionContext*, Peer*, PassOwnPtr<Vector<char> >);
177     static void mainThreadSendBlob(ScriptExecutionContext*, Peer*, const KURL&, const String& type, long long size);
178     static void mainThreadBufferedAmount(ScriptExecutionContext*, Peer*);
179     static void mainThreadClose(ScriptExecutionContext*, Peer*, int code, const String& reason);
180     static void mainThreadFail(ScriptExecutionContext*, Peer*, const String& reason);
181     static void mainThreadDestroy(ScriptExecutionContext*, PassOwnPtr<Peer>);
182     static void mainThreadSuspend(ScriptExecutionContext*, Peer*);
183     static void mainThreadResume(ScriptExecutionContext*, Peer*);
184
185     class WorkerContextDidInitializeTask;
186
187     RefPtr<WorkerContext> m_workerContext;
188     RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
189     RefPtr<Bridge> m_bridge;
190 };
191
192 } // namespace WebCore
193
194 #endif // ENABLE(WEB_SOCKETS)
195
196 #endif // WorkerThreadableWebSocketChannel_h