OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_SEQUENCE_CHECKER_H_ | 5 #ifndef BASE_SEQUENCE_CHECKER_H_ |
6 #define BASE_SEQUENCE_CHECKER_H_ | 6 #define BASE_SEQUENCE_CHECKER_H_ |
7 | 7 |
8 // See comments for the similar block in thread_checker.h. | 8 // See comments for the similar block in thread_checker.h. |
9 #if (!defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)) | 9 #if (!defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)) |
10 #define ENABLE_SEQUENCE_CHECKER 1 | 10 #define ENABLE_SEQUENCE_CHECKER 1 |
(...skipping 11 matching lines...) Expand all Loading... |
22 // the right version for your build configuration. | 22 // the right version for your build configuration. |
23 class SequenceCheckerDoNothing { | 23 class SequenceCheckerDoNothing { |
24 public: | 24 public: |
25 bool CalledOnValidSequencedThread() const { | 25 bool CalledOnValidSequencedThread() const { |
26 return true; | 26 return true; |
27 } | 27 } |
28 | 28 |
29 void DetachFromSequence() {} | 29 void DetachFromSequence() {} |
30 }; | 30 }; |
31 | 31 |
32 // SequenceChecker is a helper class used to help verify that some | 32 // SequenceChecker is a helper class to verify that calls to some methods of a |
33 // methods of a class are called in sequence -- that is, called from | 33 // class are sequenced. Calls are sequenced when they are issued from tasks |
34 // the same SequencedTaskRunner. It is a generalization of | 34 // posted to SequencedTaskRunners bound to the same sequence or from a single |
35 // ThreadChecker; see comments in sequence_checker_impl.h for details. | 35 // thread with no associated sequence token. |
36 // | 36 // |
37 // Example: | 37 // Example: |
38 // class MyClass { | 38 // class MyClass { |
39 // public: | 39 // public: |
40 // void Foo() { | 40 // void Foo() { |
41 // DCHECK(sequence_checker_.CalledOnValidSequencedThread()); | 41 // DCHECK(sequence_checker_.CalledOnValidSequencedThread()); |
42 // ... (do stuff) ... | 42 // ... (do stuff) ... |
43 // } | 43 // } |
44 // | 44 // |
45 // private: | 45 // private: |
46 // SequenceChecker sequence_checker_; | 46 // SequenceChecker sequence_checker_; |
47 // } | 47 // } |
48 // | 48 // |
49 // In Release mode, CalledOnValidSequencedThread() will always return true. | 49 // In Release mode, CalledOnValidSequencedThread() will always return true. |
50 #if ENABLE_SEQUENCE_CHECKER | 50 #if ENABLE_SEQUENCE_CHECKER |
51 class SequenceChecker : public SequenceCheckerImpl { | 51 class SequenceChecker : public SequenceCheckerImpl { |
52 }; | 52 }; |
53 #else | 53 #else |
54 class SequenceChecker : public SequenceCheckerDoNothing { | 54 class SequenceChecker : public SequenceCheckerDoNothing { |
55 }; | 55 }; |
56 #endif // ENABLE_SEQUENCE_CHECKER | 56 #endif // ENABLE_SEQUENCE_CHECKER |
57 | 57 |
58 #undef ENABLE_SEQUENCE_CHECKER | 58 #undef ENABLE_SEQUENCE_CHECKER |
59 | 59 |
60 } // namespace base | 60 } // namespace base |
61 | 61 |
62 #endif // BASE_SEQUENCE_CHECKER_H_ | 62 #endif // BASE_SEQUENCE_CHECKER_H_ |
OLD | NEW |