xref: /aosp_15_r20/external/webrtc/test/time_controller/external_time_controller.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright 2019 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 #ifndef TEST_TIME_CONTROLLER_EXTERNAL_TIME_CONTROLLER_H_
11 #define TEST_TIME_CONTROLLER_EXTERNAL_TIME_CONTROLLER_H_
12 
13 #include <functional>
14 #include <memory>
15 
16 #include "absl/strings/string_view.h"
17 #include "api/task_queue/task_queue_base.h"
18 #include "api/task_queue/task_queue_factory.h"
19 #include "api/test/time_controller.h"
20 #include "api/units/time_delta.h"
21 #include "api/units/timestamp.h"
22 #include "system_wrappers/include/clock.h"
23 #include "test/time_controller/simulated_time_controller.h"
24 
25 namespace webrtc {
26 
27 // TimeController implementation built on an external controlled alarm.
28 // This implementation is used to delegate scheduling and execution to an
29 // external run loop.
30 class ExternalTimeController : public TimeController, public TaskQueueFactory {
31  public:
32   explicit ExternalTimeController(ControlledAlarmClock* alarm);
33 
34   // Implementation of TimeController.
35   Clock* GetClock() override;
36   TaskQueueFactory* GetTaskQueueFactory() override;
37   void AdvanceTime(TimeDelta duration) override;
38   std::unique_ptr<rtc::Thread> CreateThread(
39       const std::string& name,
40       std::unique_ptr<rtc::SocketServer> socket_server) override;
41   rtc::Thread* GetMainThread() override;
42 
43   // Implementation of TaskQueueFactory.
44   std::unique_ptr<TaskQueueBase, TaskQueueDeleter> CreateTaskQueue(
45       absl::string_view name,
46       TaskQueueFactory::Priority priority) const override;
47 
48  private:
49   class TaskQueueWrapper;
50 
51   // Executes any tasks scheduled at or before the current time.  May call
52   // `ScheduleNext` to schedule the next call to `Run`.
53   void Run();
54 
55   void UpdateTime();
56   void ScheduleNext();
57 
58   ControlledAlarmClock* alarm_;
59   sim_time_impl::SimulatedTimeControllerImpl impl_;
60   rtc::ScopedYieldPolicy yield_policy_;
61 
62   // Overrides the global rtc::Clock to ensure that it reports the same times as
63   // the time controller.
64   rtc::ScopedBaseFakeClock global_clock_;
65 };
66 
67 }  // namespace webrtc
68 
69 #endif  // TEST_TIME_CONTROLLER_EXTERNAL_TIME_CONTROLLER_H_
70