blob: 56c4b7b8eeb00c7266d9bff11216e6846ba7926e [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:261/*
2 * Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Steve Anton10542f22019-01-11 17:11:0011#ifndef RTC_BASE_TEST_CLIENT_H_
12#define RTC_BASE_TEST_CLIENT_H_
henrike@webrtc.orgf0488722014-05-13 18:00:2613
Henrik Kjellanderec78f1c2017-06-29 05:52:5014#include <memory>
15#include <vector>
Jonas Olssona4d87372019-07-05 17:08:3316
Per Kd07900c2023-11-17 09:18:2517#include "api/units/timestamp.h"
Steve Anton10542f22019-01-11 17:11:0018#include "rtc_base/async_udp_socket.h"
Per Kd07900c2023-11-17 09:18:2519#include "rtc_base/buffer.h"
Steve Anton10542f22019-01-11 17:11:0020#include "rtc_base/fake_clock.h"
Per Kd07900c2023-11-17 09:18:2521#include "rtc_base/network/received_packet.h"
Markus Handell18523c32020-07-08 15:55:5822#include "rtc_base/synchronization/mutex.h"
henrike@webrtc.orgf0488722014-05-13 18:00:2623
Henrik Kjellanderec78f1c2017-06-29 05:52:5024namespace rtc {
25
26// A simple client that can send TCP or UDP data and check that it receives
27// what it expects to receive. Useful for testing server functionality.
28class TestClient : public sigslot::has_slots<> {
29 public:
30 // Records the contents of a packet that was received.
31 struct Packet {
Per Kd07900c2023-11-17 09:18:2532 Packet(const rtc::ReceivedPacket& received_packet);
Henrik Kjellanderec78f1c2017-06-29 05:52:5033 Packet(const Packet& p);
Henrik Kjellanderec78f1c2017-06-29 05:52:5034
35 SocketAddress addr;
Per Kd07900c2023-11-17 09:18:2536 Buffer buf;
Florent Castelli8037fc62024-08-29 13:00:4037 std::optional<webrtc::Timestamp> packet_time;
Henrik Kjellanderec78f1c2017-06-29 05:52:5038 };
39
40 // Default timeout for NextPacket reads.
41 static const int kTimeoutMs = 5000;
42
43 // Creates a client that will send and receive with the given socket and
44 // will post itself messages with the given thread.
45 explicit TestClient(std::unique_ptr<AsyncPacketSocket> socket);
46 // Create a test client that will use a fake clock. NextPacket needs to wait
47 // for a packet to be received, and thus it needs to advance the fake clock
48 // if the test is using one, rather than just sleeping.
Sebastian Janssond624c392019-04-17 08:36:0349 TestClient(std::unique_ptr<AsyncPacketSocket> socket,
50 ThreadProcessingFakeClock* fake_clock);
Henrik Kjellanderec78f1c2017-06-29 05:52:5051 ~TestClient() override;
52
Byoungchan Lee14af7622022-01-11 20:24:5853 TestClient(const TestClient&) = delete;
54 TestClient& operator=(const TestClient&) = delete;
55
Henrik Kjellanderec78f1c2017-06-29 05:52:5056 SocketAddress address() const { return socket_->GetLocalAddress(); }
57 SocketAddress remote_address() const { return socket_->GetRemoteAddress(); }
58
59 // Checks that the socket moves to the specified connect state.
60 bool CheckConnState(AsyncPacketSocket::State state);
61
62 // Checks that the socket is connected to the remote side.
63 bool CheckConnected() {
64 return CheckConnState(AsyncPacketSocket::STATE_CONNECTED);
65 }
66
67 // Sends using the clients socket.
68 int Send(const char* buf, size_t size);
69
70 // Sends using the clients socket to the given destination.
71 int SendTo(const char* buf, size_t size, const SocketAddress& dest);
72
73 // Returns the next packet received by the client or null if none is received
74 // within the specified timeout.
75 std::unique_ptr<Packet> NextPacket(int timeout_ms);
76
77 // Checks that the next packet has the given contents. Returns the remote
78 // address that the packet was sent from.
79 bool CheckNextPacket(const char* buf, size_t len, SocketAddress* addr);
80
81 // Checks that no packets have arrived or will arrive in the next second.
82 bool CheckNoPacket();
83
84 int GetError();
85 int SetOption(Socket::Option opt, int value);
86
87 bool ready_to_send() const { return ready_to_send_count() > 0; }
88
89 // How many times SignalReadyToSend has been fired.
90 int ready_to_send_count() const { return ready_to_send_count_; }
91
92 private:
93 // Timeout for reads when no packet is expected.
94 static const int kNoPacketTimeoutMs = 1000;
95 // Workaround for the fact that AsyncPacketSocket::GetConnState doesn't exist.
96 Socket::ConnState GetState();
Per Kd07900c2023-11-17 09:18:2597
Yves Gerey665174f2018-06-19 13:03:0598 void OnPacket(AsyncPacketSocket* socket,
Per Kd07900c2023-11-17 09:18:2599 const rtc::ReceivedPacket& received_packet);
Henrik Kjellanderec78f1c2017-06-29 05:52:50100 void OnReadyToSend(AsyncPacketSocket* socket);
Florent Castelli8037fc62024-08-29 13:00:40101 bool CheckTimestamp(std::optional<webrtc::Timestamp> packet_timestamp);
Henrik Kjellanderec78f1c2017-06-29 05:52:50102 void AdvanceTime(int ms);
103
Sebastian Janssond624c392019-04-17 08:36:03104 ThreadProcessingFakeClock* fake_clock_ = nullptr;
Markus Handell18523c32020-07-08 15:55:58105 webrtc::Mutex mutex_;
Henrik Kjellanderec78f1c2017-06-29 05:52:50106 std::unique_ptr<AsyncPacketSocket> socket_;
107 std::vector<std::unique_ptr<Packet>> packets_;
108 int ready_to_send_count_ = 0;
Florent Castelli8037fc62024-08-29 13:00:40109 std::optional<webrtc::Timestamp> prev_packet_timestamp_;
Henrik Kjellanderec78f1c2017-06-29 05:52:50110};
111
112} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:26113
Steve Anton10542f22019-01-11 17:11:00114#endif // RTC_BASE_TEST_CLIENT_H_