WorkerThreadableWebSocketChannel.h 8.56 KB
Newer Older
1
/*
2
 * Copyright (C) 2011 Google Inc.  All rights reserved.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WorkerThreadableWebSocketChannel_h
#define WorkerThreadableWebSocketChannel_h

#if ENABLE(WEB_SOCKETS) && ENABLE(WORKERS)

#include "ThreadableWebSocketChannel.h"
#include "WebSocketChannelClient.h"
38
#include "WorkerContext.h"
39
40
41
42
43

#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/Threading.h>
44
#include <wtf/text/WTFString.h>
45
46
47
48
49
50
51
52
53
54
55

namespace WebCore {

class KURL;
class ScriptExecutionContext;
class ThreadableWebSocketChannelClientWrapper;
class WorkerContext;
class WorkerLoaderProxy;
class WorkerRunLoop;

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
63
    }
    virtual ~WorkerThreadableWebSocketChannel();

64
65
66
    // ThreadableWebSocketChannel functions.
    virtual void connect(const KURL&, const String& protocol) OVERRIDE;
    virtual String subprotocol() OVERRIDE;
67
    virtual String extensions() OVERRIDE;
68
    virtual ThreadableWebSocketChannel::SendResult send(const String& message) OVERRIDE;
69
    virtual ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&, unsigned byteOffset, unsigned byteLength) OVERRIDE;
70
    virtual ThreadableWebSocketChannel::SendResult send(const Blob&) OVERRIDE;
71
72
73
74
75
76
    virtual unsigned long bufferedAmount() const OVERRIDE;
    virtual void close(int code, const String& reason) OVERRIDE;
    virtual void fail(const String& reason) OVERRIDE;
    virtual void disconnect() OVERRIDE; // Will suppress didClose().
    virtual void suspend() OVERRIDE;
    virtual void resume() OVERRIDE;
77
78
79

    // Generated by the bridge.  The Peer and its bridge should have identical
    // lifetimes.
80
81
    class Peer : public WebSocketChannelClient {
        WTF_MAKE_NONCOPYABLE(Peer); WTF_MAKE_FAST_ALLOCATED;
82
    public:
83
        static Peer* create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> clientWrapper, WorkerLoaderProxy& loaderProxy, ScriptExecutionContext* context, const String& taskMode)
84
        {
85
            return new Peer(clientWrapper, loaderProxy, context, taskMode);
86
87
88
        }
        ~Peer();

89
        void connect(const KURL&, const String& protocol);
90
        void send(const String& message);
91
        void send(const ArrayBuffer&);
92
        void send(const Blob&);
93
        void bufferedAmount();
94
        void close(int code, const String& reason);
95
        void fail(const String& reason);
96
        void disconnect();
97
98
        void suspend();
        void resume();
99

100
101
102
103
104
105
106
        // WebSocketChannelClient functions.
        virtual void didConnect() OVERRIDE;
        virtual void didReceiveMessage(const String& message) OVERRIDE;
        virtual void didReceiveBinaryData(PassOwnPtr<Vector<char> >) OVERRIDE;
        virtual void didUpdateBufferedAmount(unsigned long bufferedAmount) OVERRIDE;
        virtual void didStartClosingHandshake() OVERRIDE;
        virtual void didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) OVERRIDE;
107
        virtual void didReceiveMessageError() OVERRIDE;
108
109

    private:
110
        Peer(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, WorkerLoaderProxy&, ScriptExecutionContext*, const String& taskMode);
111

112
        RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
113
114
115
116
117
        WorkerLoaderProxy& m_loaderProxy;
        RefPtr<ThreadableWebSocketChannel> m_mainWebSocketChannel;
        String m_taskMode;
    };

118
119
120
121
122
123
124
125
    using RefCounted<WorkerThreadableWebSocketChannel>::ref;
    using RefCounted<WorkerThreadableWebSocketChannel>::deref;

protected:
    virtual void refThreadableWebSocketChannel() { ref(); }
    virtual void derefThreadableWebSocketChannel() { deref(); }

private:
126
127
128
    // Bridge for Peer.  Running on the worker thread.
    class Bridge : public RefCounted<Bridge> {
    public:
129
        static PassRefPtr<Bridge> create(PassRefPtr<ThreadableWebSocketChannelClientWrapper> workerClientWrapper, PassRefPtr<WorkerContext> workerContext, const String& taskMode)
130
        {
131
            return adoptRef(new Bridge(workerClientWrapper, workerContext, taskMode));
132
        }
133
        ~Bridge();
134
        void initialize();
135
        void connect(const KURL&, const String& protocol);
136
        ThreadableWebSocketChannel::SendResult send(const String& message);
137
        ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&, unsigned byteOffset, unsigned byteLength);
138
        ThreadableWebSocketChannel::SendResult send(const Blob&);
139
        unsigned long bufferedAmount();
140
        void close(int code, const String& reason);
141
        void fail(const String& reason);
142
        void disconnect();
143
144
        void suspend();
        void resume();
145
146
147
148
149

        using RefCounted<Bridge>::ref;
        using RefCounted<Bridge>::deref;

    private:
150
        Bridge(PassRefPtr<ThreadableWebSocketChannelClientWrapper>, PassRefPtr<WorkerContext>, const String& taskMode);
151

152
        static void setWebSocketChannel(ScriptExecutionContext*, Bridge* thisPtr, Peer*, PassRefPtr<ThreadableWebSocketChannelClientWrapper>);
153
154

        // Executed on the main thread to create a Peer for this bridge.
155
        static void mainThreadInitialize(ScriptExecutionContext*, WorkerLoaderProxy*, PassRefPtr<ThreadableWebSocketChannelClientWrapper>, const String& taskMode);
156
157
158
159
160
161
162

        // Executed on the worker context's thread.
        void clearClientWrapper();

        void setMethodNotCompleted();
        void waitForMethodCompletion();

163
        RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
164
165
166
167
168
169
        RefPtr<WorkerContext> m_workerContext;
        WorkerLoaderProxy& m_loaderProxy;
        String m_taskMode;
        Peer* m_peer;
    };

170
    WorkerThreadableWebSocketChannel(WorkerContext*, WebSocketChannelClient*, const String& taskMode);
171

172
    static void mainThreadConnect(ScriptExecutionContext*, Peer*, const KURL&, const String& protocol);
173
    static void mainThreadSend(ScriptExecutionContext*, Peer*, const String& message);
174
    static void mainThreadSendArrayBuffer(ScriptExecutionContext*, Peer*, PassOwnPtr<Vector<char> >);
175
    static void mainThreadSendBlob(ScriptExecutionContext*, Peer*, const KURL&, const String& type, long long size);
176
    static void mainThreadBufferedAmount(ScriptExecutionContext*, Peer*);
177
    static void mainThreadClose(ScriptExecutionContext*, Peer*, int code, const String& reason);
178
    static void mainThreadFail(ScriptExecutionContext*, Peer*, const String& reason);
179
    static void mainThreadDestroy(ScriptExecutionContext*, PassOwnPtr<Peer>);
180
181
    static void mainThreadSuspend(ScriptExecutionContext*, Peer*);
    static void mainThreadResume(ScriptExecutionContext*, Peer*);
182

183
184
    class WorkerContextDidInitializeTask;

185
186
187
188
189
190
191
192
193
194
    RefPtr<WorkerContext> m_workerContext;
    RefPtr<ThreadableWebSocketChannelClientWrapper> m_workerClientWrapper;
    RefPtr<Bridge> m_bridge;
};

} // namespace WebCore

#endif // ENABLE(WEB_SOCKETS)

#endif // WorkerThreadableWebSocketChannel_h