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
|
/*
* Copyright (C) 2009 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.
*/
#pragma once
#include "WebSocketIdentifier.h"
#include <wtf/Forward.h>
#include <wtf/Identified.h>
#include <wtf/Noncopyable.h>
#include <wtf/ObjectIdentifier.h>
#include <wtf/URL.h>
namespace JSC {
class ArrayBuffer;
}
namespace WebCore {
class Blob;
class Document;
class ResourceRequest;
class ResourceResponse;
class ScriptExecutionContext;
class SocketProvider;
class WebSocketChannel;
class WebSocketChannelInspector;
class WebSocketChannelClient;
using WebSocketChannelIdentifier = AtomicObjectIdentifier<WebSocketChannel>;
class ThreadableWebSocketChannel : public Identified<WebSocketIdentifier> {
WTF_MAKE_NONCOPYABLE(ThreadableWebSocketChannel);
public:
static RefPtr<ThreadableWebSocketChannel> create(Document&, WebSocketChannelClient&, SocketProvider&);
static RefPtr<ThreadableWebSocketChannel> create(ScriptExecutionContext&, WebSocketChannelClient&, SocketProvider&);
WEBCORE_EXPORT ThreadableWebSocketChannel();
void ref() { refThreadableWebSocketChannel(); }
void deref() { derefThreadableWebSocketChannel(); }
enum class ConnectStatus { KO, OK };
virtual ConnectStatus connect(const URL&, const String& protocol) = 0;
virtual String subprotocol() = 0; // Will be available after didConnect() callback is invoked.
virtual String extensions() = 0; // Will be available after didConnect() callback is invoked.
virtual void send(CString&&) = 0;
virtual void send(const JSC::ArrayBuffer&, unsigned byteOffset, unsigned byteLength) = 0;
virtual void send(Blob&) = 0;
virtual void close(int code, const String& reason) = 0;
// Log the reason text and close the connection. Will call didClose().
virtual void fail(String&& reason) = 0;
virtual void disconnect() = 0; // Will suppress didClose().
virtual void suspend() = 0;
virtual void resume() = 0;
virtual const WebSocketChannelInspector* channelInspector() const { return nullptr; };
virtual WebSocketChannelIdentifier progressIdentifier() const = 0;
virtual bool hasCreatedHandshake() const = 0;
virtual bool isConnected() const = 0;
using CookieGetter = Function<String(const URL&)>;
virtual ResourceRequest clientHandshakeRequest(const CookieGetter&) const = 0;
virtual const ResourceResponse& serverHandshakeResponse() const = 0;
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
};
protected:
virtual ~ThreadableWebSocketChannel() = default;
virtual void refThreadableWebSocketChannel() = 0;
virtual void derefThreadableWebSocketChannel() = 0;
struct ValidatedURL {
URL url;
bool areCookiesAllowed { true };
};
WEBCORE_EXPORT static std::optional<ValidatedURL> validateURL(Document&, const URL&);
WEBCORE_EXPORT static std::optional<ResourceRequest> webSocketConnectRequest(Document&, const URL&);
};
} // namespace WebCore
|
