webrtc/rtc_base/task_utils/repeating_task.cc
Sebastian Jansson d841ea6b58 Skip return value check for stopped repeating tasks.
If the repeated task stopped itself, the return value does not matter,
therefore we don't have to check it.

Bug: webrtc:10365
Change-Id: I4a2c7a40a287dd0a8099628e228e9c319409576b
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/127545
Commit-Queue: Sebastian Jansson <srte@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#27121}
2019-03-14 08:31:19 +00:00

119 lines
3.5 KiB
C++

/*
* Copyright 2019 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.
*/
#include "rtc_base/task_utils/repeating_task.h"
#include "rtc_base/logging.h"
#include "rtc_base/task_utils/to_queued_task.h"
#include "rtc_base/time_utils.h"
namespace webrtc {
namespace webrtc_repeating_task_impl {
RepeatingTaskBase::RepeatingTaskBase(TaskQueueBase* task_queue,
TimeDelta first_delay)
: task_queue_(task_queue),
next_run_time_(Timestamp::us(rtc::TimeMicros()) + first_delay) {}
RepeatingTaskBase::~RepeatingTaskBase() = default;
bool RepeatingTaskBase::Run() {
RTC_DCHECK_RUN_ON(task_queue_);
// Return true to tell the TaskQueue to destruct this object.
if (next_run_time_.IsPlusInfinity())
return true;
TimeDelta delay = RunClosure();
// The closure might have stopped this task, in which case we return true to
// destruct this object.
if (next_run_time_.IsPlusInfinity())
return true;
RTC_DCHECK(delay.IsFinite());
TimeDelta lost_time = Timestamp::us(rtc::TimeMicros()) - next_run_time_;
next_run_time_ += delay;
delay -= lost_time;
delay = std::max(delay, TimeDelta::Zero());
task_queue_->PostDelayedTask(absl::WrapUnique(this), delay.ms());
// Return false to tell the TaskQueue to not destruct this object since we
// have taken ownership with absl::WrapUnique.
return false;
}
void RepeatingTaskBase::Stop() {
RTC_DCHECK(next_run_time_.IsFinite());
next_run_time_ = Timestamp::PlusInfinity();
}
void RepeatingTaskBase::PostStop() {
if (task_queue_->IsCurrent()) {
RTC_DLOG(LS_INFO) << "Using PostStop() from the task queue running the "
"repeated task. Consider calling Stop() instead.";
}
task_queue_->PostTask(ToQueuedTask([this] {
RTC_DCHECK_RUN_ON(task_queue_);
Stop();
}));
}
} // namespace webrtc_repeating_task_impl
RepeatingTaskHandle::RepeatingTaskHandle() {
sequence_checker_.Detach();
}
RepeatingTaskHandle::~RepeatingTaskHandle() {
sequence_checker_.Detach();
}
RepeatingTaskHandle::RepeatingTaskHandle(RepeatingTaskHandle&& other)
: repeating_task_(other.repeating_task_) {
RTC_DCHECK_RUN_ON(&sequence_checker_);
other.repeating_task_ = nullptr;
}
RepeatingTaskHandle& RepeatingTaskHandle::operator=(
RepeatingTaskHandle&& other) {
RTC_DCHECK_RUN_ON(&other.sequence_checker_);
{
RTC_DCHECK_RUN_ON(&sequence_checker_);
repeating_task_ = other.repeating_task_;
}
other.repeating_task_ = nullptr;
return *this;
}
RepeatingTaskHandle::RepeatingTaskHandle(
webrtc_repeating_task_impl::RepeatingTaskBase* repeating_task)
: repeating_task_(repeating_task) {}
void RepeatingTaskHandle::Stop() {
RTC_DCHECK_RUN_ON(&sequence_checker_);
if (repeating_task_) {
RTC_DCHECK_RUN_ON(repeating_task_->task_queue_);
repeating_task_->Stop();
repeating_task_ = nullptr;
}
}
void RepeatingTaskHandle::PostStop() {
RTC_DCHECK_RUN_ON(&sequence_checker_);
if (repeating_task_) {
repeating_task_->PostStop();
repeating_task_ = nullptr;
}
}
bool RepeatingTaskHandle::Running() const {
RTC_DCHECK_RUN_ON(&sequence_checker_);
return repeating_task_ != nullptr;
}
} // namespace webrtc