blob: 35bd3cd4ae303f52fd83bec3b804db03f37e3f12 [file] [log] [blame]
* Copyright (c) 2016 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.
// Apart from debug builds, we also enable the sequence checker in
// builds with RTC_DCHECK_IS_ON so that trybots and waterfall bots
// with this define will get the same level of checking as debug bots.
#include "webrtc/rtc_base/checks.h"
#include "webrtc/rtc_base/constructormagic.h"
#include "webrtc/rtc_base/sequenced_task_checker_impl.h"
#include "webrtc/rtc_base/thread_annotations.h"
namespace rtc {
// Do nothing implementation, for use in release mode.
// Note: You should almost always use the SequencedTaskChecker class to get the
// right version for your build configuration.
class SequencedTaskCheckerDoNothing {
bool CalledSequentially() const { return true; }
void Detach() {}
// SequencedTaskChecker is a helper class used to help verify that some methods
// of a class are called on the same task queue or thread. A
// SequencedTaskChecker is bound to a a task queue if the object is
// created on a task queue, or a thread otherwise.
// Example:
// class MyClass {
// public:
// void Foo() {
// RTC_DCHECK(sequence_checker_.CalledSequentially());
// ... (do stuff) ...
// }
// private:
// SequencedTaskChecker sequence_checker_;
// }
// In Release mode, CalledOnValidThread will always return true.
class RTC_LOCKABLE SequencedTaskChecker : public SequencedTaskCheckerImpl {};
class RTC_LOCKABLE SequencedTaskChecker : public SequencedTaskCheckerDoNothing {
namespace internal {
class RTC_SCOPED_LOCKABLE SequencedTaskCheckerScope {
explicit SequencedTaskCheckerScope(const SequencedTaskChecker* checker)
~SequencedTaskCheckerScope() RTC_UNLOCK_FUNCTION();
} // namespace internal
rtc::internal::SequencedTaskCheckerScope checker(x)
} // namespace rtc