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
226
227
228
229
230
231
232
|
/*
* Copyright (C) 2011 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 DOMWebSocket_h
#define DOMWebSocket_h
#include "core/dom/ActiveDOMObject.h"
#include "core/events/EventListener.h"
#include "modules/EventTargetModules.h"
#include "modules/websockets/WebSocketChannel.h"
#include "modules/websockets/WebSocketChannelClient.h"
#include "platform/Timer.h"
#include "platform/heap/Handle.h"
#include "platform/weborigin/KURL.h"
#include "wtf/Deque.h"
#include "wtf/Forward.h"
#include "wtf/text/AtomicStringHash.h"
namespace blink {
class Blob;
class ExceptionState;
class DOMWebSocket : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<DOMWebSocket>, public EventTargetWithInlineData, public ActiveDOMObject, public WebSocketChannelClient {
DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<DOMWebSocket>);
DEFINE_WRAPPERTYPEINFO();
USING_GARBAGE_COLLECTED_MIXIN(DOMWebSocket);
public:
static const char* subprotocolSeperator();
// DOMWebSocket instances must be used with a wrapper since this class's
// lifetime management is designed assuming the V8 holds a ref on it while
// hasPendingActivity() returns true.
static DOMWebSocket* create(ExecutionContext*, const String& url, ExceptionState&);
static DOMWebSocket* create(ExecutionContext*, const String& url, const String& protocol, ExceptionState&);
static DOMWebSocket* create(ExecutionContext*, const String& url, const Vector<String>& protocols, ExceptionState&);
virtual ~DOMWebSocket();
enum State {
CONNECTING = 0,
OPEN = 1,
CLOSING = 2,
CLOSED = 3
};
void connect(const String& url, const Vector<String>& protocols, ExceptionState&);
void send(const String& message, ExceptionState&);
void send(ArrayBuffer*, ExceptionState&);
void send(ArrayBufferView*, ExceptionState&);
void send(Blob*, ExceptionState&);
// To distinguish close method call with the code parameter from one
// without, we have these three signatures. Use of
// Optional=DefaultIsUndefined in the IDL file doesn't help for now since
// it's bound to a value of 0 which is indistinguishable from the case 0
// is passed as code parameter.
void close(unsigned short code, const String& reason, ExceptionState&);
void close(ExceptionState&);
void close(unsigned short code, ExceptionState&);
const KURL& url() const;
State readyState() const;
unsigned long bufferedAmount() const;
String protocol() const;
String extensions() const;
String binaryType() const;
void setBinaryType(const String&);
DEFINE_ATTRIBUTE_EVENT_LISTENER(open);
DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
// EventTarget functions.
virtual const AtomicString& interfaceName() const override;
virtual ExecutionContext* executionContext() const override;
// ActiveDOMObject functions.
virtual void contextDestroyed() override;
// Prevent this instance from being collected while it's not in CLOSED
// state.
virtual bool hasPendingActivity() const override;
virtual void suspend() override;
virtual void resume() override;
virtual void stop() override;
// WebSocketChannelClient functions.
virtual void didConnect(const String& subprotocol, const String& extensions) override;
virtual void didReceiveTextMessage(const String& message) override;
virtual void didReceiveBinaryMessage(PassOwnPtr<Vector<char> >) override;
virtual void didError() override;
virtual void didConsumeBufferedAmount(unsigned long) override;
virtual void didStartClosingHandshake() override;
virtual void didClose(ClosingHandshakeCompletionStatus, unsigned short code, const String& reason) override;
virtual void trace(Visitor*) override;
static bool isValidSubprotocolString(const String&);
protected:
explicit DOMWebSocket(ExecutionContext*);
private:
// FIXME: This should inherit blink::EventQueue.
class EventQueue final : public GarbageCollectedFinalized<EventQueue> {
public:
static EventQueue* create(EventTarget* target)
{
return new EventQueue(target);
}
~EventQueue();
// Dispatches the event if this queue is active.
// Queues the event if this queue is suspended.
// Does nothing otherwise.
void dispatch(PassRefPtrWillBeRawPtr<Event> /* event */);
bool isEmpty() const;
void suspend();
void resume();
void stop();
void trace(Visitor*);
private:
enum State {
Active,
Suspended,
Stopped,
};
explicit EventQueue(EventTarget*);
// Dispatches queued events if this queue is active.
// Does nothing otherwise.
void dispatchQueuedEvents();
void resumeTimerFired(Timer<EventQueue>*);
State m_state;
EventTarget* m_target;
WillBeHeapDeque<RefPtrWillBeMember<Event> > m_events;
Timer<EventQueue> m_resumeTimer;
};
enum WebSocketSendType {
WebSocketSendTypeString,
WebSocketSendTypeArrayBuffer,
WebSocketSendTypeArrayBufferView,
WebSocketSendTypeBlob,
WebSocketSendTypeMax,
};
// This function is virtual for unittests.
// FIXME: Move WebSocketChannel::create here.
virtual WebSocketChannel* createChannel(ExecutionContext* context, WebSocketChannelClient* client)
{
return WebSocketChannel::create(context, client);
}
// Adds a console message with JSMessageSource and ErrorMessageLevel.
void logError(const String& message);
// Handle the JavaScript close method call. close() methods on this class
// are just for determining if the optional code argument is supplied or
// not.
void closeInternal(int, const String&, ExceptionState&);
size_t getFramingOverhead(size_t payloadSize);
// Updates m_bufferedAmountAfterClose given the amount of data passed to
// send() method after the state changed to CLOSING or CLOSED.
void updateBufferedAmountAfterClose(unsigned long);
void reflectBufferedAmountConsumption(Timer<DOMWebSocket>*);
void releaseChannel();
enum BinaryType {
BinaryTypeBlob,
BinaryTypeArrayBuffer
};
Member<WebSocketChannel> m_channel;
State m_state;
KURL m_url;
unsigned long m_bufferedAmount;
// The consumed buffered amount that will be reflected to m_bufferedAmount
// later. It will be cleared once reflected.
unsigned long m_consumedBufferedAmount;
unsigned long m_bufferedAmountAfterClose;
BinaryType m_binaryType;
// The subprotocol the server selected.
String m_subprotocol;
String m_extensions;
Member<EventQueue> m_eventQueue;
Timer<DOMWebSocket> m_bufferedAmountConsumeTimer;
};
} // namespace blink
#endif // DOMWebSocket_h
|
