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
|
/*
* Copyright (C) 2013 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 DocumentWebSocketChannel_h
#define DocumentWebSocketChannel_h
#include <stdint.h>
#include <memory>
#include "bindings/core/v8/SourceLocation.h"
#include "core/fileapi/Blob.h"
#include "core/fileapi/FileError.h"
#include "modules/ModulesExport.h"
#include "modules/websockets/WebSocketChannel.h"
#include "modules/websockets/WebSocketHandle.h"
#include "modules/websockets/WebSocketHandleClient.h"
#include "platform/WebFrameScheduler.h"
#include "platform/heap/Handle.h"
#include "platform/weborigin/KURL.h"
#include "wtf/Deque.h"
#include "wtf/PassRefPtr.h"
#include "wtf/RefPtr.h"
#include "wtf/Vector.h"
#include "wtf/text/CString.h"
#include "wtf/text/WTFString.h"
namespace blink {
class Document;
class WebSocketHandshakeRequest;
// This class is a WebSocketChannel subclass that works with a Document in a
// DOMWindow (i.e. works in the main thread).
class MODULES_EXPORT DocumentWebSocketChannel final
: public WebSocketChannel,
public WebSocketHandleClient {
public:
// You can specify the source file and the line number information
// explicitly by passing the last parameter.
// In the usual case, they are set automatically and you don't have to
// pass it.
// Specify handle explicitly only in tests.
static DocumentWebSocketChannel* create(
Document* document,
WebSocketChannelClient* client,
std::unique_ptr<SourceLocation> location,
WebSocketHandle* handle = 0) {
return new DocumentWebSocketChannel(document, client, std::move(location),
handle);
}
~DocumentWebSocketChannel() override;
// WebSocketChannel functions.
bool connect(const KURL&, const String& protocol) override;
void send(const CString& message) override;
void send(const DOMArrayBuffer&,
unsigned byteOffset,
unsigned byteLength) override;
void send(PassRefPtr<BlobDataHandle>) override;
void sendTextAsCharVector(std::unique_ptr<Vector<char>> data) override;
void sendBinaryAsCharVector(std::unique_ptr<Vector<char>> data) override;
// Start closing handshake. Use the CloseEventCodeNotSpecified for the code
// argument to omit payload.
void close(int code, const String& reason) override;
void fail(const String& reason,
MessageLevel,
std::unique_ptr<SourceLocation>) override;
void disconnect() override;
DECLARE_VIRTUAL_TRACE();
private:
class BlobLoader;
class Message;
enum MessageType {
MessageTypeText,
MessageTypeBlob,
MessageTypeArrayBuffer,
MessageTypeTextAsCharVector,
MessageTypeBinaryAsCharVector,
MessageTypeClose,
};
struct ReceivedMessage {
bool isMessageText;
Vector<char> data;
};
DocumentWebSocketChannel(Document*,
WebSocketChannelClient*,
std::unique_ptr<SourceLocation>,
WebSocketHandle*);
void sendInternal(WebSocketHandle::MessageType,
const char* data,
size_t totalSize,
uint64_t* consumedBufferedAmount);
void processSendQueue();
void flowControlIfNecessary();
void failAsError(const String& reason) {
fail(reason, ErrorMessageLevel, m_locationAtConstruction->clone());
}
void abortAsyncOperations();
void handleDidClose(bool wasClean, unsigned short code, const String& reason);
Document* document();
// WebSocketHandleClient functions.
void didConnect(WebSocketHandle*,
const String& selectedProtocol,
const String& extensions) override;
void didStartOpeningHandshake(WebSocketHandle*,
PassRefPtr<WebSocketHandshakeRequest>) override;
void didFinishOpeningHandshake(WebSocketHandle*,
const WebSocketHandshakeResponse*) override;
void didFail(WebSocketHandle*, const String& message) override;
void didReceiveData(WebSocketHandle*,
bool fin,
WebSocketHandle::MessageType,
const char* data,
size_t) override;
void didClose(WebSocketHandle*,
bool wasClean,
unsigned short code,
const String& reason) override;
void didReceiveFlowControl(WebSocketHandle*, int64_t quota) override;
void didStartClosingHandshake(WebSocketHandle*) override;
// Methods for BlobLoader.
void didFinishLoadingBlob(DOMArrayBuffer*);
void didFailLoadingBlob(FileError::ErrorCode);
// m_handle is a handle of the connection.
// m_handle == 0 means this channel is closed.
std::unique_ptr<WebSocketHandle> m_handle;
// m_client can be deleted while this channel is alive, but this class
// expects that disconnect() is called before the deletion.
Member<WebSocketChannelClient> m_client;
KURL m_url;
// m_identifier > 0 means calling scriptContextExecution() returns a Document.
unsigned long m_identifier;
Member<BlobLoader> m_blobLoader;
HeapDeque<Member<Message>> m_messages;
Vector<char> m_receivingMessageData;
Member<Document> m_document;
bool m_receivingMessageTypeIsText;
uint64_t m_sendingQuota;
uint64_t m_receivedDataSizeForFlowControl;
size_t m_sentSizeOfTopMessage;
std::unique_ptr<WebFrameScheduler::ActiveConnectionHandle>
connection_handle_for_scheduler_;
std::unique_ptr<SourceLocation> m_locationAtConstruction;
RefPtr<WebSocketHandshakeRequest> m_handshakeRequest;
static const uint64_t receivedDataSizeForFlowControlHighWaterMark = 1 << 15;
};
std::ostream& operator<<(std::ostream&, const DocumentWebSocketChannel*);
} // namespace blink
#endif // DocumentWebSocketChannel_h
|
