blob: 4e1d7927cb53385febc3142bbd241ddb6dfbe8da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_THREAD_CHECKER_H_
#define BASE_THREAD_CHECKER_H_
#pragma once
#include "base/platform_thread.h"
// Before using this class, please consider using NonThreadSafe as it
// makes it much easier to determine the nature of your class.
//
// A helper class used to help verify that some methods of a class are
// called from the same thread. One can inherit from this class and use
// CalledOnValidThread() to verify.
//
// Inheriting from class indicates that one must be careful when using the class
// with multiple threads. However, it is up to the class document to indicate
// how it can be used with threads.
//
// Example:
// class MyClass : public ThreadChecker {
// public:
// void Foo() {
// DCHECK(CalledOnValidThread());
// ... (do stuff) ...
// }
// }
//
// In Release mode, CalledOnValidThread will always return true.
//
#ifndef NDEBUG
class ThreadChecker {
public:
ThreadChecker();
bool CalledOnValidThread() const;
private:
const PlatformThreadId valid_thread_id_;
};
#else
// Do nothing in release mode.
class ThreadChecker {
public:
bool CalledOnValidThread() const {
return true;
}
};
#endif // NDEBUG
#endif // BASE_THREAD_CHECKER_H_
|
