diff options
Diffstat (limited to 'third_party/libwebrtc/api/metronome/test/fake_metronome.h')
-rw-r--r-- | third_party/libwebrtc/api/metronome/test/fake_metronome.h | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/third_party/libwebrtc/api/metronome/test/fake_metronome.h b/third_party/libwebrtc/api/metronome/test/fake_metronome.h new file mode 100644 index 0000000000..73c938e9cd --- /dev/null +++ b/third_party/libwebrtc/api/metronome/test/fake_metronome.h @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2022 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_METRONOME_TEST_FAKE_METRONOME_H_ +#define API_METRONOME_TEST_FAKE_METRONOME_H_ + +#include <memory> +#include <set> +#include <vector> + +#include "api/metronome/metronome.h" +#include "api/task_queue/task_queue_base.h" +#include "api/task_queue/task_queue_factory.h" +#include "api/units/time_delta.h" +#include "rtc_base/synchronization/mutex.h" +#include "rtc_base/task_queue.h" +#include "rtc_base/task_utils/repeating_task.h" +#include "rtc_base/thread_annotations.h" + +namespace webrtc::test { + +// ForcedTickMetronome is a Metronome that ticks when `Tick()` is invoked. +// The constructor argument `tick_period` returned in `TickPeriod()`. +class ForcedTickMetronome : public Metronome { + public: + explicit ForcedTickMetronome(TimeDelta tick_period); + + // Forces all TickListeners to run `OnTick`. + void Tick(); + size_t NumListeners(); + + // Metronome implementation. + void RequestCallOnNextTick(absl::AnyInvocable<void() &&> callback) override; + TimeDelta TickPeriod() const override; + + private: + const TimeDelta tick_period_; + std::vector<absl::AnyInvocable<void() &&>> callbacks_; +}; + +// FakeMetronome is a metronome that ticks based on a repeating task at the +// `tick_period` provided in the constructor. It is designed for use with +// simulated task queues for unit tests. +// +// `Stop()` must be called before destruction, as it cancels the metronome tick +// on the proper task queue. +class FakeMetronome : public Metronome { + public: + explicit FakeMetronome(TimeDelta tick_period); + + // Metronome implementation. + void RequestCallOnNextTick(absl::AnyInvocable<void() &&> callback) override; + TimeDelta TickPeriod() const override; + + private: + const TimeDelta tick_period_; + std::vector<absl::AnyInvocable<void() &&>> callbacks_; +}; + +} // namespace webrtc::test + +#endif // API_METRONOME_TEST_FAKE_METRONOME_H_ |