webrtc/rtc_base/task_queue_for_test.h
Tommi 685615678a Introduce TaskQueueForTest.
This class adds a convenience method that allows *sending* a task
to the queue (as opposed to posting). Sending is essentially
Post+Wait, a pattern that we don't want to encourage use of
in production code, but is convenient to have from a testing
perspective and there are already several places in the
source code where we use it.

Change-Id: I6efd1b2257e6c641294bb6e4eb53b0021d9553ca
Bug: webrtc:8848
Reviewed-on: https://webrtc-review.googlesource.com/50441
Reviewed-by: Magnus Jedvert <magjed@webrtc.org>
Commit-Queue: Tommi <tommi@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#22022}
2018-02-14 15:32:49 +00:00

61 lines
2 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 "rtc_base/checks.h"
#include "rtc_base/event.h"
#include "rtc_base/task_queue.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(false, false);
PostTask(rtc::NewClosure(
[&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(false, false);
PostTask(rtc::NewClosure(std::move(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_