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 #include "base/memory/ref_counted.h" | 8 #include "base/memory/ref_counted.h" |
9 | 9 |
10 // See comments for the similar block in thread_checker.h. | 10 // See comments for the similar block in thread_checker.h. |
(...skipping 10 matching lines...) Expand all Loading... |
21 namespace base { | 21 namespace base { |
22 | 22 |
23 class SequencedTaskRunner; | 23 class SequencedTaskRunner; |
24 | 24 |
25 // Do nothing implementation, for use in release mode. | 25 // Do nothing implementation, for use in release mode. |
26 // | 26 // |
27 // Note: You should almost always use the SequenceChecker class to get | 27 // Note: You should almost always use the SequenceChecker class to get |
28 // the right version for your build configuration. | 28 // the right version for your build configuration. |
29 class SequenceCheckerDoNothing { | 29 class SequenceCheckerDoNothing { |
30 public: | 30 public: |
31 bool CalledOnValidSequence() const { | 31 bool CalledOnValidSequencedThread() const { |
32 return true; | 32 return true; |
33 } | 33 } |
34 | 34 |
35 void ChangeSequence( | 35 void DetachFromSequence() {} |
36 const scoped_refptr<SequencedTaskRunner>& sequenced_task_runner) {} | |
37 }; | 36 }; |
38 | 37 |
39 // SequenceChecker is a helper class used to help verify that some | 38 // SequenceChecker is a helper class used to help verify that some |
40 // methods of a class are called in sequence -- that is, called from | 39 // methods of a class are called in sequence -- that is, called from |
41 // the same SequencedTaskRunner. It is a generalization of | 40 // the same SequencedTaskRunner. It is a generalization of |
42 // ThreadChecker; see comments in sequence_checker_impl.h for details. | 41 // ThreadChecker; see comments in sequence_checker_impl.h for details. |
43 // | 42 // |
44 // Example: | 43 // Example: |
45 // class MyClass { | 44 // class MyClass { |
46 // public: | 45 // public: |
47 // explicit MyClass( | |
48 // const scoped_refptr<SequencedTaskRunner>& sequenced_task_runner) | |
49 // : sequence_checker_(sequenced_task_runner) {} | |
50 // | |
51 // void Foo() { | 46 // void Foo() { |
52 // DCHECK(sequence_checker_.CalledOnValidSequence()); | 47 // DCHECK(sequence_checker_.CalledOnValidSequence()); |
53 // ... (do stuff) ... | 48 // ... (do stuff) ... |
54 // } | 49 // } |
55 // | 50 // |
56 // private: | 51 // private: |
57 // SequenceChecker sequence_checker_; | 52 // SequenceChecker sequence_checker_; |
58 // } | 53 // } |
59 // | 54 // |
60 // In Release mode, CalledOnValidSequence will always return true. | 55 // In Release mode, CalledOnValidSequence will always return true. |
61 #if ENABLE_SEQUENCE_CHECKER | 56 #if ENABLE_SEQUENCE_CHECKER |
62 class SequenceChecker : public SequenceCheckerImpl { | 57 class SequenceChecker : public SequenceCheckerImpl { |
63 public: | |
64 explicit SequenceChecker( | |
65 const scoped_refptr<SequencedTaskRunner>& sequenced_task_runner) | |
66 : SequenceCheckerImpl(sequenced_task_runner) {} | |
67 }; | 58 }; |
68 #else | 59 #else |
69 class SequenceChecker : public SequenceCheckerDoNothing { | 60 class SequenceChecker : public SequenceCheckerDoNothing { |
70 public: | |
71 explicit SequenceChecker( | |
72 const scoped_refptr<SequencedTaskRunner>& sequenced_task_runner) {} | |
73 }; | 61 }; |
74 #endif // ENABLE_SEQUENCE_CHECKER | 62 #endif // ENABLE_SEQUENCE_CHECKER |
75 | 63 |
76 #undef ENABLE_SEQUENCE_CHECKER | 64 #undef ENABLE_SEQUENCE_CHECKER |
77 | 65 |
78 } // namespace base | 66 } // namespace base |
79 | 67 |
80 #endif // BASE_SEQUENCE_CHECKER_H_ | 68 #endif // BASE_SEQUENCE_CHECKER_H_ |
OLD | NEW |