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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_TEST_CHROMEDRIVER_NET_WEBSOCKET_H_
#define CHROME_TEST_CHROMEDRIVER_NET_WEBSOCKET_H_
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/threading/thread_checker.h"
#include "net/base/completion_once_callback.h"
#include "net/socket/tcp_client_socket.h"
#include "net/websockets/websocket_frame.h"
#include "net/websockets/websocket_frame_parser.h"
#include "url/gurl.h"
namespace net {
class DrainableIOBuffer;
class IOBufferWithSize;
}
class WebSocketListener;
// A text-only, non-thread safe WebSocket. Must be created and used on a single
// thread. Intended particularly for use with net::HttpServer.
class WebSocket {
public:
// |url| must be an IP v4/v6 literal, not a host name.
WebSocket(const GURL& url,
WebSocketListener* listener,
size_t read_buffer_size = 4096);
WebSocket(const WebSocket&) = delete;
WebSocket& operator=(const WebSocket&) = delete;
virtual ~WebSocket();
// Initializes the WebSocket connection. Invokes the given callback with
// a net::Error. May only be called once.
void Connect(net::CompletionOnceCallback callback);
// Sends the given message and returns true on success.
bool Send(const std::string& message);
private:
enum State {
INITIALIZED,
CONNECTING,
OPEN,
CLOSED
};
void OnSocketConnect(int code);
void Write(const std::string& data);
void OnWrite(int code);
void ContinueWritingIfNecessary();
void Read();
void OnRead(bool read_again, int code);
void OnReadDuringHandshake(base::span<const uint8_t> data_span);
void OnReadDuringOpen(base::span<uint8_t> data_span);
void InvokeConnectCallback(int code);
void Close(int code);
base::ThreadChecker thread_checker_;
GURL url_;
raw_ptr<WebSocketListener> listener_;
State state_;
std::unique_ptr<net::TCPClientSocket> socket_;
net::CompletionOnceCallback connect_callback_;
std::string sec_key_;
std::string handshake_response_;
scoped_refptr<net::DrainableIOBuffer> write_buffer_;
std::string pending_write_;
scoped_refptr<net::IOBufferWithSize> read_buffer_;
net::WebSocketFrameParser parser_;
net::WebSocketMaskingKey current_masking_key_ = {};
bool is_current_frame_masked_ = false;
bool is_current_message_opcode_text_ = false;
uint64_t current_frame_offset_ = 0;
std::string next_message_;
};
// Listens for WebSocket messages and disconnects on the same thread as the
// WebSocket.
class WebSocketListener {
public:
virtual ~WebSocketListener() = default;
// Called when a WebSocket message is received.
virtual void OnMessageReceived(const std::string& message) = 0;
// Called when the WebSocket connection closes. Will be called at most once.
// Will not be called if the connection was never established or if the close
// was initiated by the client.
virtual void OnClose() = 0;
};
#endif // CHROME_TEST_CHROMEDRIVER_NET_WEBSOCKET_H_
|