2011-06-23 Darin Adler <darin@apple.com>
[WebKit-https.git] / Source / WebCore / websockets / WorkerThreadableWebSocketChannel.h
1 /*
2  * Copyright (C) 2009, 2010 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
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/RefCounted.h>
42 #include <wtf/RefPtr.h>
43 #include <wtf/Threading.h>
44
45 namespace WebCore {
46
47 class KURL;
48 class ScriptExecutionContext;
49 class ThreadableWebSocketChannelClientWrapper;
50 class WorkerContext;
51 class WorkerLoaderProxy;
52 class WorkerRunLoop;
53
54 class WorkerThreadableWebSocketChannel : public RefCounted<WorkerThreadableWebSocketChannel>, public ThreadableWebSocketChannel {
55     WTF_MAKE_FAST_ALLOCATED;
56 public:
57     static PassRefPtr<ThreadableWebSocketChannel> create(WorkerContext* workerContext, WebSocketChannelClient* client, const String& taskMode, const KURL& url, const String& protocol)
58     {
59         return adoptRef(new WorkerThreadableWebSocketChannel(workerContext, client, taskMode, url, protocol));
60     }
61     virtual ~WorkerThreadableWebSocketChannel();
62
63     virtual void connect();
64     virtual bool send(const String& message);
65     virtual unsigned long bufferedAmount() const;
66     virtual void close();
67     virtual void fail(const String& reason);
68     virtual void disconnect(); // Will suppress didClose().
69     virtual void suspend();
70     virtual void resume();
71
72     using RefCounted<WorkerThreadableWebSocketChannel>::ref;
73     using RefCounted<WorkerThreadableWebSocketChannel>::deref;
74
75 protected:
76     virtual void refThreadableWebSocketChannel() { ref(); }
77     virtual void derefThreadableWebSocketChannel() { deref(); }
78
79 private:
80     // Generated by the bridge.  The Peer and its bridge should have identical
81     // lifetimes.
82     class Peer : public WebSocketChannelClient {
83         WTF_MAKE_NONCOPYABLE(Peer); WTF_MAKE_FAST_ALLOCATED;
84     public:
85         static Peer* create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, ScriptExecutionContext* context, const String& taskMode, const KURL& url, const String& protocol)
86         {
87             return new Peer(clientWrapper, loaderProxy, context, taskMode, url, protocol);
88         }
89         ~Peer();
90
91         void connect();
92         void send(const String& message);
93         void bufferedAmount();
94         void close();
95         void fail(const String& reason);
96         void disconnect();
97         void suspend();
98         void resume();
99
100         virtual void didConnect();
101         virtual void didReceiveMessage(const String& message);
102         virtual void didStartClosingHandshake();
103         virtual void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus);
104
105     private:
106         Peer(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, WorkerLoaderProxy&, ScriptExecutionContext*, const String& taskMode, const KURL&, const String& protocol);
107
108         RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
109         WorkerLoaderProxy& m_loaderProxy;
110         RefPtr<ThreadableWebSocketChannel> m_mainWebSocketChannel;
111         String m_taskMode;
112     };
113
114     // Bridge for Peer.  Running on the worker thread.
115     class Bridge : public RefCounted<Bridge> {
116     public:
117         static PassRefPtr<Bridge> create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, PassRefPtr<WorkerContext> workerContext, const String& taskMode, const KURL& url, const String& protocol)
118         {
119             return adoptRef(new Bridge(workerClientWrapper, workerContext, taskMode, url, protocol));
120         }
121         ~Bridge();
122         void connect();
123         bool send(const String& message);
124         unsigned long bufferedAmount();
125         void close();
126         void fail(const String& reason);
127         void disconnect();
128         void suspend();
129         void resume();
130
131         using RefCounted<Bridge>::ref;
132         using RefCounted<Bridge>::deref;
133
134     private:
135         Bridge(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, PassRefPtr<WorkerContext>, const String& taskMode, const KURL&, const String& protocol);
136
137         static void setWebSocketChannel(ScriptExecutionContext*, Bridge* thisPtr, Peer*, PassRefPtr<ThreadableWebSocketChannelClientWrapper>);
138
139         // Executed on the main thread to create a Peer for this bridge.
140         static void mainThreadCreateWebSocketChannel(ScriptExecutionContext*, Bridge* thisPtr, PassRefPtr<ThreadableWebSocketChannelClientWrapper>, const String& taskMode, const KURL&, const String& protocol);
141
142         // Executed on the worker context's thread.
143         void clearClientWrapper();
144
145         void setMethodNotCompleted();
146         void waitForMethodCompletion();
147
148         RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
149         RefPtr<WorkerContext> m_workerContext;
150         WorkerLoaderProxy& m_loaderProxy;
151         String m_taskMode;
152         Peer* m_peer;
153     };
154
155     WorkerThreadableWebSocketChannel(WorkerContext*, WebSocketChannelClient*, const String& taskMode, const KURL&, const String& protocol);
156
157     static void mainThreadConnect(ScriptExecutionContext*, Peer*);
158     static void mainThreadSend(ScriptExecutionContext*, Peer*, const String& message);
159     static void mainThreadBufferedAmount(ScriptExecutionContext*, Peer*);
160     static void mainThreadClose(ScriptExecutionContext*, Peer*);
161     static void mainThreadFail(ScriptExecutionContext*, Peer*, const String& reason);
162     static void mainThreadDestroy(ScriptExecutionContext*, Peer*);
163     static void mainThreadSuspend(ScriptExecutionContext*, Peer*);
164     static void mainThreadResume(ScriptExecutionContext*, Peer*);
165
166     RefPtr<WorkerContext> m_workerContext;
167     RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
168     RefPtr<Bridge> m_bridge;
169 };
170
171 } // namespace WebCore
172
173 #endif // ENABLE(WEB_SOCKETS)
174
175 #endif // WorkerThreadableWebSocketChannel_h