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 API_TEST_TIME_CONTROLLER_H_ 11 #define API_TEST_TIME_CONTROLLER_H_ 12 13 #include <functional> 14 #include <memory> 15 #include <string> 16 17 #include "api/task_queue/task_queue_factory.h" 18 #include "api/units/time_delta.h" 19 #include "api/units/timestamp.h" 20 #include "modules/utility/include/process_thread.h" 21 #include "rtc_base/synchronization/yield_policy.h" 22 #include "rtc_base/thread.h" 23 #include "system_wrappers/include/clock.h" 24 25 namespace webrtc { 26 // Interface for controlling time progress. This allows us to execute test code 27 // in either real time or simulated time by using different implementation of 28 // this interface. 29 class TimeController { 30 public: 31 virtual ~TimeController() = default; 32 // Provides a clock instance that follows implementation defined time 33 // progress. 34 virtual Clock* GetClock() = 0; 35 // The returned factory will created task queues that runs in implementation 36 // defined time domain. 37 virtual TaskQueueFactory* GetTaskQueueFactory() = 0; 38 // Simple helper to create an owned factory that can be used as a parameter 39 // for PeerConnectionFactory. Note that this might depend on the underlying 40 // time controller and therfore must be destroyed before the time controller 41 // is destroyed. 42 std::unique_ptr<TaskQueueFactory> CreateTaskQueueFactory(); 43 44 // Creates a process thread. 45 virtual std::unique_ptr<ProcessThread> CreateProcessThread( 46 const char* thread_name) = 0; 47 // Creates an rtc::Thread instance. If |socket_server| is nullptr, a default 48 // noop socket server is created. 49 // Returned thread is not null and started. 50 virtual std::unique_ptr<rtc::Thread> CreateThread( 51 const std::string& name, 52 std::unique_ptr<rtc::SocketServer> socket_server = nullptr) = 0; 53 54 // Creates an rtc::Thread instance that ensure that it's set as the current 55 // thread. 56 virtual rtc::Thread* GetMainThread() = 0; 57 // Allow task queues and process threads created by this instance to execute 58 // for the given |duration|. 59 virtual void AdvanceTime(TimeDelta duration) = 0; 60 61 // Waits until condition() == true, polling condition() in small time 62 // intervals. 63 // Returns true if condition() was evaluated to true before |max_duration| 64 // elapsed and false otherwise. 65 bool Wait(const std::function<bool()>& condition, 66 TimeDelta max_duration = TimeDelta::Seconds(5)); 67 }; 68 69 // Interface for telling time, scheduling an event to fire at a particular time, 70 // and waiting for time to pass. 71 class ControlledAlarmClock { 72 public: 73 virtual ~ControlledAlarmClock() = default; 74 75 // Gets a clock that tells the alarm clock's notion of time. 76 virtual Clock* GetClock() = 0; 77 78 // Schedules the alarm to fire at |deadline|. 79 // An alarm clock only supports one deadline. Calls to |ScheduleAlarmAt| with 80 // an earlier deadline will reset the alarm to fire earlier.Calls to 81 // |ScheduleAlarmAt| with a later deadline are ignored. Returns true if the 82 // deadline changed, false otherwise. 83 virtual bool ScheduleAlarmAt(Timestamp deadline) = 0; 84 85 // Sets the callback that should be run when the alarm fires. 86 virtual void SetCallback(std::function<void()> callback) = 0; 87 88 // Waits for |duration| to pass, according to the alarm clock. 89 virtual void Sleep(TimeDelta duration) = 0; 90 }; 91 92 } // namespace webrtc 93 #endif // API_TEST_TIME_CONTROLLER_H_ 94