mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 13:50:40 +01:00
ce1320cc4d
Add an utility function to TaskQueueForTest to execute all already posted tasks on the queue. Bug: webrtc:11380 Change-Id: I6cf75bc543cfd2dd1c363935134d3f7bd55eec58 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/174140 Commit-Queue: Marina Ciocea <marinaciocea@webrtc.org> Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Reviewed-by: Danil Chapovalov <danilchap@webrtc.org> Cr-Commit-Position: refs/heads/master@{#31152}
81 lines
2.9 KiB
C++
81 lines
2.9 KiB
C++
/*
|
|
* Copyright 2018 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 RTC_BASE_TASK_QUEUE_FOR_TEST_H_
|
|
#define RTC_BASE_TASK_QUEUE_FOR_TEST_H_
|
|
|
|
#include <utility>
|
|
|
|
#include "absl/strings/string_view.h"
|
|
#include "api/task_queue/task_queue_base.h"
|
|
#include "rtc_base/checks.h"
|
|
#include "rtc_base/event.h"
|
|
#include "rtc_base/location.h"
|
|
#include "rtc_base/task_queue.h"
|
|
#include "rtc_base/task_utils/to_queued_task.h"
|
|
#include "rtc_base/thread_annotations.h"
|
|
|
|
namespace webrtc {
|
|
|
|
template <typename Closure>
|
|
void SendTask(rtc::Location loc, TaskQueueBase* task_queue, Closure&& task) {
|
|
RTC_CHECK(!task_queue->IsCurrent())
|
|
<< "Called SendTask to a queue from the same queue at " << loc.ToString();
|
|
rtc::Event event;
|
|
task_queue->PostTask(
|
|
ToQueuedTask(std::forward<Closure>(task), [&event] { event.Set(); }));
|
|
RTC_CHECK(event.Wait(/*give_up_after_ms=*/rtc::Event::kForever,
|
|
/*warn_after_ms=*/10'000))
|
|
<< "Waited too long at " << loc.ToString();
|
|
}
|
|
|
|
class RTC_LOCKABLE TaskQueueForTest : public rtc::TaskQueue {
|
|
public:
|
|
using rtc::TaskQueue::TaskQueue;
|
|
explicit TaskQueueForTest(absl::string_view name = "TestQueue",
|
|
Priority priority = Priority::NORMAL);
|
|
TaskQueueForTest(const TaskQueueForTest&) = delete;
|
|
TaskQueueForTest& operator=(const TaskQueueForTest&) = delete;
|
|
~TaskQueueForTest() = default;
|
|
|
|
// A convenience, test-only method that blocks the current thread while
|
|
// a task executes on the task queue.
|
|
// This variant is specifically for posting custom QueuedTask derived
|
|
// implementations that tests do not want to pass ownership of over to the
|
|
// task queue (i.e. the Run() method always returns |false|.).
|
|
template <class Closure>
|
|
void SendTask(Closure* task) {
|
|
RTC_CHECK(!IsCurrent());
|
|
rtc::Event event;
|
|
PostTask(ToQueuedTask(
|
|
[&task] { RTC_CHECK_EQ(false, static_cast<QueuedTask*>(task)->Run()); },
|
|
[&event] { event.Set(); }));
|
|
event.Wait(rtc::Event::kForever);
|
|
}
|
|
|
|
// A convenience, test-only method that blocks the current thread while
|
|
// a task executes on the task queue.
|
|
template <class Closure>
|
|
void SendTask(Closure&& task, rtc::Location loc) {
|
|
::webrtc::SendTask(loc, Get(), std::forward<Closure>(task));
|
|
}
|
|
|
|
// Wait for the completion of all tasks posted prior to the
|
|
// WaitForPreviouslyPostedTasks() call.
|
|
void WaitForPreviouslyPostedTasks() {
|
|
// Post an empty task on the queue and wait for it to finish, to ensure
|
|
// that all already posted tasks on the queue get executed.
|
|
SendTask([]() {}, RTC_FROM_HERE);
|
|
}
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // RTC_BASE_TASK_QUEUE_FOR_TEST_H_
|