blob: e65315a5159e1b8fe15cba99657a807cda86e0fb [file] [log] [blame]
/*
* 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/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 = ObjectIdentifier<WebSocketChannel>;
class ThreadableWebSocketChannel {
WTF_MAKE_NONCOPYABLE(ThreadableWebSocketChannel);
public:
static Ref<ThreadableWebSocketChannel> create(Document&, WebSocketChannelClient&, SocketProvider&);
static Ref<ThreadableWebSocketChannel> create(ScriptExecutionContext&, WebSocketChannelClient&, SocketProvider&);
WEBCORE_EXPORT ThreadableWebSocketChannel();
void ref() { refThreadableWebSocketChannel(); }
void deref() { derefThreadableWebSocketChannel(); }
WebSocketIdentifier identifier() const { return m_identifier; };
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.
enum SendResult { SendSuccess, SendFail };
virtual SendResult send(CString&&) = 0;
virtual SendResult send(const JSC::ArrayBuffer&, unsigned byteOffset, unsigned byteLength) = 0;
virtual SendResult send(Blob&) = 0;
virtual unsigned bufferedAmount() const = 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;
protected:
virtual ~ThreadableWebSocketChannel() = default;
virtual void refThreadableWebSocketChannel() = 0;
virtual void derefThreadableWebSocketChannel() = 0;
struct ValidatedURL {
URL url;
bool areCookiesAllowed { true };
};
static std::optional<ValidatedURL> validateURL(Document&, const URL&);
WEBCORE_EXPORT static std::optional<ResourceRequest> webSocketConnectRequest(Document&, const URL&);
WebSocketIdentifier m_identifier;
};
} // namespace WebCore