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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_HANDLER_H_
#define NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_HANDLER_H_
#include <stdint.h>
#include <optional>
#include <string_view>
#include "base/containers/span.h"
#include "base/memory/scoped_refptr.h"
namespace net::test_server {
class WebSocketConnection;
struct HttpRequest;
// Base class defining methods for handling WebSocket connections.
// Subclasses should implement the methods to define specific WebSocket server
// behavior.
class WebSocketHandler {
public:
WebSocketHandler(const WebSocketHandler&) = delete;
WebSocketHandler& operator=(const WebSocketHandler&) = delete;
// The handler will be automatically destroyed when the WebSocket
// disconnects.
virtual ~WebSocketHandler();
// Called when a valid WebSocket handshake has been received, before the
// response headers are sent.
virtual void OnHandshake(const HttpRequest& request) {}
// Called after handshake response headers have been sent.
virtual void OnHandshakeComplete() {}
// Called when a text message has been received. `message` will only be valid
// until this call returns.
virtual void OnTextMessage(std::string_view message) {}
// Called when a binary message has been received. `message` will only be
// valid until this call returns.
virtual void OnBinaryMessage(base::span<const uint8_t> message) {}
// Called when a PING frame has been received. `payload` will only be valid
// until this call returns. By default, it responds with a PONG message.
virtual void OnPing(base::span<const uint8_t> payload);
// Called when a PONG frame has been received. `payload` will only be valid
// until this call returns. Default behavior is no-op.
virtual void OnPong(base::span<const uint8_t> payload);
// Called when a CLOSE frame is received from the remote server. `code` will
// be std::nullopt if the CLOSE frame contained no data. `message` will only
// be valid until this call returns. The default implementation responds with
// a close frame.
virtual void OnClosingHandshake(std::optional<uint16_t> code,
std::string_view message);
protected:
// Constructor that initializes the WebSocketHandler with a pointer to the
// WebSocketConnection it interacts with.
explicit WebSocketHandler(scoped_refptr<WebSocketConnection> connection);
// Provides access to the associated WebSocketConnection.
const scoped_refptr<WebSocketConnection>& connection() const {
return connection_;
}
private:
// Pointer to the WebSocketConnection associated with this handler.
const scoped_refptr<WebSocketConnection> connection_;
};
} // namespace net::test_server
#endif // NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_HANDLER_H_
|
