File: network_queue.h

package info (click to toggle)
firefox 147.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,320 kB
  • sloc: cpp: 7,607,359; javascript: 6,533,295; ansic: 3,775,223; python: 1,415,500; xml: 634,561; asm: 438,949; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (61 lines) | stat: -rw-r--r-- 2,213 bytes parent folder | download | duplicates (9)
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
/*
 *  Copyright 2025 The WebRTC Project Authors. All rights reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#ifndef API_TEST_NETWORK_EMULATION_NETWORK_QUEUE_H_
#define API_TEST_NETWORK_EMULATION_NETWORK_QUEUE_H_

#include <cstddef>
#include <memory>
#include <optional>
#include <vector>

#include "api/test/simulated_network.h"
#include "api/units/timestamp.h"

namespace webrtc {

// NetworkQueue defines the interface for a queue used in network simulation.
// The purpose is to allow for different AQM implementations.
// A queue should not modify PacketInFlightInfo except for the explicit
// congestion notification field (ecn).
class NetworkQueue {
 public:
  // Max capacity a queue is expected to handle.
  constexpr static size_t kMaxPacketCapacity = 10000;

  virtual ~NetworkQueue() = default;
  // Sets the max capacity of the queue. If there are already more than
  // `max_capacitiy` packets in the queue, the behaviour depends on the
  // implementation.
  virtual void SetMaxPacketCapacity(size_t max_capactiy) = 0;
  // Enqueues a packet.
  // Must return true if the packet is enqueued successfully, false otherwise.
  virtual bool EnqueuePacket(const PacketInFlightInfo& packet_info) = 0;
  // Next packet that can be dequeued.
  virtual std::optional<PacketInFlightInfo> PeekNextPacket() const = 0;
  // Dequeues a packet.
  // or std::nullopt if there are no enqueued packets.
  virtual std::optional<PacketInFlightInfo> DequeuePacket(
      Timestamp time_now) = 0;

  // Dequeues all packets that are dropped by the queue itself after being
  // enqueued.
  virtual std::vector<PacketInFlightInfo> DequeueDroppedPackets() = 0;
  virtual bool empty() const = 0;
};

class NetworkQueueFactory {
 public:
  virtual ~NetworkQueueFactory() = default;
  virtual std::unique_ptr<NetworkQueue> CreateQueue() = 0;
};

}  // namespace webrtc
#endif  // API_TEST_NETWORK_EMULATION_NETWORK_QUEUE_H_