blob: 0becc80975c06010fe7bdb9e613e5efc78efd74a [file] [log] [blame]
/*
* 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 "rtc_base/checks.h"
#include "rtc_base/constructor_magic.h"
#include "rtc_base/event.h"
#include "rtc_base/task_queue.h"
#include "rtc_base/task_utils/to_queued_task.h"
#include "rtc_base/thread_annotations.h"
namespace rtc {
namespace test {
class RTC_LOCKABLE TaskQueueForTest : public TaskQueue {
public:
explicit TaskQueueForTest(const char* queue_name,
Priority priority = Priority::NORMAL);
~TaskQueueForTest();
// 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_DCHECK(!IsCurrent());
rtc::Event event;
PostTask(webrtc::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_DCHECK(!IsCurrent());
rtc::Event event;
PostTask(webrtc::ToQueuedTask(std::forward<Closure>(task),
[&event] { event.Set(); }));
event.Wait(rtc::Event::kForever);
}
private:
RTC_DISALLOW_COPY_AND_ASSIGN(TaskQueueForTest);
};
} // namespace test
} // namespace rtc
#endif // RTC_BASE_TASK_QUEUE_FOR_TEST_H_