1
2
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* Copyright (C) 2011, 2012 Google Inc. All rights reserved.
*
* 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 WebSocketChannel_h
#define WebSocketChannel_h
#if ENABLE(WEB_SOCKETS)
#include "FileReaderLoaderClient.h"
#include "SocketStreamHandleClient.h"
#include "ThreadableWebSocketChannel.h"
#include "Timer.h"
#include "WebSocketDeflateFramer.h"
#include "WebSocketFrame.h"
#include "WebSocketHandshake.h"
#include <wtf/Deque.h>
#include <wtf/Forward.h>
#include <wtf/RefCounted.h>
#include <wtf/Vector.h>
#include <wtf/text/CString.h>
namespace WebCore {
class Blob;
class Document;
class FileReaderLoader;
class SocketStreamHandle;
class SocketStreamError;
class WebSocketChannelClient;
class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient, public ThreadableWebSocketChannel, public FileReaderLoaderClient
{
WTF_MAKE_FAST_ALLOCATED;
public:
static Ref<WebSocketChannel> create(Document* document, WebSocketChannelClient* client) { return adoptRef(*new WebSocketChannel(document, client)); }
virtual ~WebSocketChannel();
bool send(const char* data, int length);
// ThreadableWebSocketChannel functions.
virtual void connect(const URL&, const String& protocol) override;
virtual String subprotocol() override;
virtual String extensions() override;
virtual ThreadableWebSocketChannel::SendResult send(const String& message) override;
virtual ThreadableWebSocketChannel::SendResult send(const JSC::ArrayBuffer&, unsigned byteOffset, unsigned byteLength) override;
virtual ThreadableWebSocketChannel::SendResult send(Blob&) override;
virtual unsigned long bufferedAmount() const override;
virtual void close(int code, const String& reason) override; // Start closing handshake.
virtual void fail(const String& reason) override;
virtual void disconnect() override;
virtual void suspend() override;
virtual void resume() override;
// SocketStreamHandleClient functions.
virtual void willOpenSocketStream(SocketStreamHandle*) override;
virtual void didOpenSocketStream(SocketStreamHandle*) override;
virtual void didCloseSocketStream(SocketStreamHandle*) override;
virtual void didReceiveSocketStreamData(SocketStreamHandle*, const char*, int) override;
virtual void didUpdateBufferedAmount(SocketStreamHandle*, size_t bufferedAmount) override;
virtual void didFailSocketStream(SocketStreamHandle*, const SocketStreamError&) override;
virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) override;
virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) override;
enum CloseEventCode {
CloseEventCodeNotSpecified = -1,
CloseEventCodeNormalClosure = 1000,
CloseEventCodeGoingAway = 1001,
CloseEventCodeProtocolError = 1002,
CloseEventCodeUnsupportedData = 1003,
CloseEventCodeFrameTooLarge = 1004,
CloseEventCodeNoStatusRcvd = 1005,
CloseEventCodeAbnormalClosure = 1006,
CloseEventCodeInvalidFramePayloadData = 1007,
CloseEventCodePolicyViolation = 1008,
CloseEventCodeMessageTooBig = 1009,
CloseEventCodeMandatoryExt = 1010,
CloseEventCodeInternalError = 1011,
CloseEventCodeTLSHandshake = 1015,
CloseEventCodeMinimumUserDefined = 3000,
CloseEventCodeMaximumUserDefined = 4999
};
// FileReaderLoaderClient functions.
virtual void didStartLoading() override;
virtual void didReceiveData() override;
virtual void didFinishLoading() override;
virtual void didFail(int errorCode) override;
using RefCounted<WebSocketChannel>::ref;
using RefCounted<WebSocketChannel>::deref;
protected:
virtual void refThreadableWebSocketChannel() override { ref(); }
virtual void derefThreadableWebSocketChannel() override { deref(); }
private:
WebSocketChannel(Document*, WebSocketChannelClient*);
bool appendToBuffer(const char* data, size_t len);
void skipBuffer(size_t len);
bool processBuffer();
void resumeTimerFired();
void startClosingHandshake(int code, const String& reason);
void closingTimerFired();
bool processFrame();
// It is allowed to send a Blob as a binary frame if hybi-10 protocol is in use. Sending a Blob
// can be delayed because it must be read asynchronously. Other types of data (String or
// ArrayBuffer) may also be blocked by preceding sending request of a Blob.
//
// To address this situation, messages to be sent need to be stored in a queue. Whenever a new
// data frame is going to be sent, it first must go to the queue. Items in the queue are processed
// in the order they were put into the queue. Sending request of a Blob blocks further processing
// until the Blob is completely read and sent to the socket stream.
enum QueuedFrameType {
QueuedFrameTypeString,
QueuedFrameTypeVector,
QueuedFrameTypeBlob
};
struct QueuedFrame {
WebSocketFrame::OpCode opCode;
QueuedFrameType frameType;
// Only one of the following items is used, according to the value of frameType.
CString stringData;
Vector<char> vectorData;
RefPtr<Blob> blobData;
};
void enqueueTextFrame(const CString&);
void enqueueRawFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
void enqueueBlobFrame(WebSocketFrame::OpCode, Blob&);
void processOutgoingFrameQueue();
void abortOutgoingFrameQueue();
enum OutgoingFrameQueueStatus {
// It is allowed to put a new item into the queue.
OutgoingFrameQueueOpen,
// Close frame has already been put into the queue but may not have been sent yet;
// m_handle->close() will be called as soon as the queue is cleared. It is not
// allowed to put a new item into the queue.
OutgoingFrameQueueClosing,
// Close frame has been sent or the queue was aborted. It is not allowed to put
// a new item to the queue.
OutgoingFrameQueueClosed
};
// If you are going to send a hybi-10 frame, you need to use the outgoing frame queue
// instead of call sendFrame() directly.
bool sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
enum BlobLoaderStatus {
BlobLoaderNotStarted,
BlobLoaderStarted,
BlobLoaderFinished,
BlobLoaderFailed
};
Document* m_document;
WebSocketChannelClient* m_client;
std::unique_ptr<WebSocketHandshake> m_handshake;
RefPtr<SocketStreamHandle> m_handle;
Vector<char> m_buffer;
Timer m_resumeTimer;
bool m_suspended;
bool m_closing;
bool m_receivedClosingHandshake;
Timer m_closingTimer;
bool m_closed;
bool m_shouldDiscardReceivedData;
unsigned long m_unhandledBufferedAmount;
unsigned long m_identifier; // m_identifier == 0 means that we could not obtain a valid identifier.
// Private members only for hybi-10 protocol.
bool m_hasContinuousFrame;
WebSocketFrame::OpCode m_continuousFrameOpCode;
Vector<uint8_t> m_continuousFrameData;
unsigned short m_closeEventCode;
String m_closeEventReason;
Deque<std::unique_ptr<QueuedFrame>> m_outgoingFrameQueue;
OutgoingFrameQueueStatus m_outgoingFrameQueueStatus;
// FIXME: Load two or more Blobs simultaneously for better performance.
std::unique_ptr<FileReaderLoader> m_blobLoader;
BlobLoaderStatus m_blobLoaderStatus;
WebSocketDeflateFramer m_deflateFramer;
};
} // namespace WebCore
#endif // ENABLE(WEB_SOCKETS)
#endif // WebSocketChannel_h
|
