mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-15 06:40:43 +01:00
15a82c93d0
This CL finalizes the Metronome refactor undertaken in crbug.com/1381982 and enables it again in call.cc. Fixed: chromium:1381982 Change-Id: I1642103e9c8a3f2a1f12d7635a1b27310802c1c3 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/282920 Commit-Queue: Markus Handell <handellm@webrtc.org> Reviewed-by: Evan Shrubsole <eshr@webrtc.org> Reviewed-by: Erik Språng <sprang@webrtc.org> Reviewed-by: Per Kjellander <perkj@webrtc.org> Cr-Commit-Position: refs/heads/main@{#38605}
47 lines
1.7 KiB
C++
47 lines
1.7 KiB
C++
/*
|
|
* 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_METRONOME_H_
|
|
#define API_METRONOME_METRONOME_H_
|
|
|
|
#include "api/task_queue/task_queue_base.h"
|
|
#include "api/units/time_delta.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
|
|
namespace webrtc {
|
|
|
|
// The Metronome posts OnTick() calls requested with RequestCallOnNextTick.
|
|
// The API is designed to be fully used from a single task queue. Scheduled
|
|
// callbacks are executed on the same sequence as they were requested on. There
|
|
// are no features implemented for cancellation. When that's needed, use e.g.
|
|
// ScopedTaskSafety from the client.
|
|
//
|
|
// The metronome concept is still under experimentation, and may not be availble
|
|
// in all platforms or applications. See https://crbug.com/1253787 for more
|
|
// details.
|
|
//
|
|
// Metronome implementations must be thread-compatible.
|
|
class RTC_EXPORT Metronome {
|
|
public:
|
|
virtual ~Metronome() = default;
|
|
|
|
// Requests a call to `callback` on the next tick. Scheduled callbacks are
|
|
// executed on the same sequence as they were requested on. There are no
|
|
// features for cancellation. When that's needed, use e.g. ScopedTaskSafety
|
|
// from the client.
|
|
virtual void RequestCallOnNextTick(absl::AnyInvocable<void() &&> callback) {}
|
|
|
|
// Returns the current tick period of the metronome.
|
|
virtual TimeDelta TickPeriod() const = 0;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // API_METRONOME_METRONOME_H_
|