OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 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_SYNCHRONIZATION_CANCELLATION_FLAG_H_ | 5 #ifndef BASE_SYNCHRONIZATION_ATOMIC_FLAG_H_ |
6 #define BASE_SYNCHRONIZATION_CANCELLATION_FLAG_H_ | 6 #define BASE_SYNCHRONIZATION_ATOMIC_FLAG_H_ |
7 | 7 |
8 #include "base/atomicops.h" | 8 #include "base/atomicops.h" |
9 #include "base/base_export.h" | 9 #include "base/base_export.h" |
10 #include "base/macros.h" | 10 #include "base/macros.h" |
11 #include "base/threading/platform_thread.h" | 11 #include "base/threading/thread_checker.h" |
12 | 12 |
13 namespace base { | 13 namespace base { |
14 | 14 |
15 // CancellationFlag allows one thread to cancel jobs executed on some worker | 15 // A flag that can safely be set from one thread and read from other threads. |
16 // thread. Calling Set() from one thread and IsSet() from a number of threads | |
17 // is thread-safe. | |
18 // | 16 // |
19 // This class IS NOT intended for synchronization between threads. | 17 // This class IS NOT intended for synchronization between threads. |
20 class BASE_EXPORT CancellationFlag { | 18 class BASE_EXPORT AtomicFlag { |
21 public: | 19 public: |
22 CancellationFlag() : flag_(false) { | 20 AtomicFlag(); |
23 #if !defined(NDEBUG) | 21 ~AtomicFlag() = default; |
24 set_on_ = PlatformThread::CurrentId(); | |
25 #endif | |
26 } | |
27 ~CancellationFlag() {} | |
28 | 22 |
29 // Set the flag. May only be called on the thread which owns the object. | 23 // Set the flag. May only be called on the thread which created the object. |
30 void Set(); | 24 void Set(); |
31 bool IsSet() const; // Returns true iff the flag was set. | |
32 | 25 |
33 // For subtle reasons that may be different on different architectures, | 26 // Returns true iff the flag was set. |
34 // a different thread testing IsSet() may erroneously read 'true' after | 27 bool IsSet() const; |
35 // this method has been called. | 28 |
| 29 // Resets the flag. Be careful when using this: callers might not expect |
| 30 // IsSet() to return false after returning true once. |
36 void UnsafeResetForTesting(); | 31 void UnsafeResetForTesting(); |
37 | 32 |
38 private: | 33 private: |
39 base::subtle::Atomic32 flag_; | 34 base::subtle::Atomic32 flag_ = 0; |
40 #if !defined(NDEBUG) | 35 ThreadChecker thread_checker_; |
41 PlatformThreadId set_on_; | |
42 #endif | |
43 | 36 |
44 DISALLOW_COPY_AND_ASSIGN(CancellationFlag); | 37 DISALLOW_COPY_AND_ASSIGN(AtomicFlag); |
45 }; | 38 }; |
46 | 39 |
47 } // namespace base | 40 } // namespace base |
48 | 41 |
49 #endif // BASE_SYNCHRONIZATION_CANCELLATION_FLAG_H_ | 42 #endif // BASE_SYNCHRONIZATION_ATOMIC_FLAG_H_ |
OLD | NEW |