blob: fbf5c5ca29ecefc11671b3f3815291ea677ad1ef [file] [log] [blame]
Patrik Höglundb6b29e02018-06-21 14:58:011/*
2 * Copyright (c) 2018 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
11#ifndef API_TEST_SIMULATED_NETWORK_H_
12#define API_TEST_SIMULATED_NETWORK_H_
13
14#include <stddef.h>
15#include <stdint.h>
Jonas Olssona4d87372019-07-05 17:08:3316
Patrik Höglundb6b29e02018-06-21 14:58:0117#include <deque>
18#include <queue>
19#include <vector>
20
Danil Chapovalov065a52a2018-07-09 08:58:5421#include "absl/types/optional.h"
Patrik Höglundb6b29e02018-06-21 14:58:0122#include "rtc_base/random.h"
23#include "rtc_base/thread_annotations.h"
24
25namespace webrtc {
26
27struct PacketInFlightInfo {
28 PacketInFlightInfo(size_t size, int64_t send_time_us, uint64_t packet_id)
29 : size(size), send_time_us(send_time_us), packet_id(packet_id) {}
30
31 size_t size;
32 int64_t send_time_us;
33 // Unique identifier for the packet in relation to other packets in flight.
34 uint64_t packet_id;
35};
36
37struct PacketDeliveryInfo {
38 static constexpr int kNotReceived = -1;
39 PacketDeliveryInfo(PacketInFlightInfo source, int64_t receive_time_us)
40 : receive_time_us(receive_time_us), packet_id(source.packet_id) {}
41 int64_t receive_time_us;
42 uint64_t packet_id;
43};
44
Artem Titov666fb322018-10-08 09:31:0945// BuiltInNetworkBehaviorConfig is a built-in network behavior configuration
46// for built-in network behavior that will be used by WebRTC if no custom
Artem Titov24ee1672018-10-04 11:48:4847// NetworkBehaviorInterface is provided.
Artem Titov666fb322018-10-08 09:31:0948struct BuiltInNetworkBehaviorConfig {
Per Kjellander8623c752021-02-15 10:34:1049 // Queue length in number of packets.
Artem Titove9721f22018-08-16 09:41:4450 size_t queue_length_packets = 0;
51 // Delay in addition to capacity induced delay.
52 int queue_delay_ms = 0;
53 // Standard deviation of the extra delay.
54 int delay_standard_deviation_ms = 0;
55 // Link capacity in kbps.
56 int link_capacity_kbps = 0;
57 // Random packet loss.
58 int loss_percent = 0;
59 // If packets are allowed to be reordered.
60 bool allow_reordering = false;
61 // The average length of a burst of lost packets.
62 int avg_burst_loss_length = -1;
Sebastian Jansson8c8feb92019-01-29 14:59:1763 // Additional bytes to add to packet size.
64 int packet_overhead = 0;
Artem Titove9721f22018-08-16 09:41:4465};
66
Artem Titov24ee1672018-10-04 11:48:4867class NetworkBehaviorInterface {
Patrik Höglundb6b29e02018-06-21 14:58:0168 public:
Patrik Höglundb6b29e02018-06-21 14:58:0169 virtual bool EnqueuePacket(PacketInFlightInfo packet_info) = 0;
70 // Retrieves all packets that should be delivered by the given receive time.
71 virtual std::vector<PacketDeliveryInfo> DequeueDeliverablePackets(
72 int64_t receive_time_us) = 0;
Artem Titovc8e202f2018-08-27 12:59:2973 // Returns time in microseconds when caller should call
74 // DequeueDeliverablePackets to get next set of packets to deliver.
Patrik Höglundb6b29e02018-06-21 14:58:0175 virtual absl::optional<int64_t> NextDeliveryTimeUs() const = 0;
Artem Titov24ee1672018-10-04 11:48:4876 virtual ~NetworkBehaviorInterface() = default;
Patrik Höglundb6b29e02018-06-21 14:58:0177};
78
Sebastian Janssoncec24332019-12-04 13:26:5079// Class simulating a network link. This is a simple and naive solution just
80// faking capacity and adding an extra transport delay in addition to the
81// capacity introduced delay.
82class SimulatedNetworkInterface : public NetworkBehaviorInterface {
83 public:
84 // Sets a new configuration. This won't affect packets already in the pipe.
85 virtual void SetConfig(const BuiltInNetworkBehaviorConfig& config) = 0;
Sebastian Jansson89eb0bb2020-03-13 16:47:3886 virtual void UpdateConfig(
87 std::function<void(BuiltInNetworkBehaviorConfig*)> config_modifier) = 0;
Sebastian Janssoncec24332019-12-04 13:26:5088 virtual void PauseTransmissionUntil(int64_t until_us) = 0;
89};
90
Patrik Höglundb6b29e02018-06-21 14:58:0191} // namespace webrtc
92
93#endif // API_TEST_SIMULATED_NETWORK_H_