1/*
2 * Copyright (C) 2009 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 * * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#pragma once
32
33#include <wtf/Forward.h>
34#include <wtf/Noncopyable.h>
35#include <wtf/URL.h>
36
37namespace JSC {
38class ArrayBuffer;
39}
40
41namespace WebCore {
42
43class Blob;
44class Document;
45class ResourceRequest;
46class ScriptExecutionContext;
47class SocketProvider;
48class WebSocketChannelClient;
49
50class ThreadableWebSocketChannel {
51 WTF_MAKE_NONCOPYABLE(ThreadableWebSocketChannel);
52public:
53 static Ref<ThreadableWebSocketChannel> create(ScriptExecutionContext&, WebSocketChannelClient&, SocketProvider&);
54 ThreadableWebSocketChannel() = default;
55
56 virtual bool isWebSocketChannel() const { return false; }
57
58 enum SendResult {
59 SendSuccess,
60 SendFail
61 };
62
63 enum class ConnectStatus { KO, OK };
64 virtual ConnectStatus connect(const URL&, const String& protocol) = 0;
65 virtual String subprotocol() = 0; // Will be available after didConnect() callback is invoked.
66 virtual String extensions() = 0; // Will be available after didConnect() callback is invoked.
67 virtual SendResult send(const String& message) = 0;
68 virtual SendResult send(const JSC::ArrayBuffer&, unsigned byteOffset, unsigned byteLength) = 0;
69 virtual SendResult send(Blob&) = 0;
70 virtual unsigned bufferedAmount() const = 0;
71 virtual void close(int code, const String& reason) = 0;
72 // Log the reason text and close the connection. Will call didClose().
73 virtual void fail(const String& reason) = 0;
74 virtual void disconnect() = 0; // Will suppress didClose().
75
76 virtual void suspend() = 0;
77 virtual void resume() = 0;
78
79 void ref() { refThreadableWebSocketChannel(); }
80 void deref() { derefThreadableWebSocketChannel(); }
81
82protected:
83 virtual ~ThreadableWebSocketChannel() = default;
84 virtual void refThreadableWebSocketChannel() = 0;
85 virtual void derefThreadableWebSocketChannel() = 0;
86
87 struct ValidatedURL {
88 URL url;
89 bool areCookiesAllowed { true };
90 };
91 static Optional<ValidatedURL> validateURL(Document&, const URL&);
92 WEBCORE_EXPORT static Optional<ResourceRequest> webSocketConnectRequest(Document&, const URL&);
93};
94
95} // namespace WebCore
96