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