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_THREADING_THREAD_H_ | 5 #ifndef BASE_THREADING_THREAD_H_ |
6 #define BASE_THREADING_THREAD_H_ | 6 #define BASE_THREADING_THREAD_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/base_export.h" | 10 #include "base/base_export.h" |
11 #include "base/callback.h" | 11 #include "base/callback.h" |
12 #include "base/memory/scoped_ptr.h" | 12 #include "base/memory/scoped_ptr.h" |
13 #include "base/message_loop/message_loop.h" | 13 #include "base/message_loop/message_loop.h" |
14 #include "base/message_loop/message_loop_proxy.h" | |
15 #include "base/message_loop/timer_slack.h" | 14 #include "base/message_loop/timer_slack.h" |
| 15 #include "base/single_thread_task_runner.h" |
| 16 #include "base/synchronization/lock.h" |
16 #include "base/threading/platform_thread.h" | 17 #include "base/threading/platform_thread.h" |
17 | 18 |
18 namespace base { | 19 namespace base { |
19 | 20 |
20 class MessagePump; | 21 class MessagePump; |
| 22 class WaitableEvent; |
21 | 23 |
22 // A simple thread abstraction that establishes a MessageLoop on a new thread. | 24 // A simple thread abstraction that establishes a MessageLoop on a new thread. |
23 // The consumer uses the MessageLoop of the thread to cause code to execute on | 25 // The consumer uses the MessageLoop of the thread to cause code to execute on |
24 // the thread. When this object is destroyed the thread is terminated. All | 26 // the thread. When this object is destroyed the thread is terminated. All |
25 // pending tasks queued on the thread's message loop will run to completion | 27 // pending tasks queued on the thread's message loop will run to completion |
26 // before the thread is terminated. | 28 // before the thread is terminated. |
27 // | 29 // |
28 // WARNING! SUBCLASSES MUST CALL Stop() IN THEIR DESTRUCTORS! See ~Thread(). | 30 // WARNING! SUBCLASSES MUST CALL Stop() IN THEIR DESTRUCTORS! See ~Thread(). |
29 // | 31 // |
30 // After the thread is stopped, the destruction sequence is: | 32 // After the thread is stopped, the destruction sequence is: |
31 // | 33 // |
32 // (1) Thread::CleanUp() | 34 // (1) Thread::CleanUp() |
33 // (2) MessageLoop::~MessageLoop | 35 // (2) MessageLoop::~MessageLoop |
34 // (3.b) MessageLoop::DestructionObserver::WillDestroyCurrentMessageLoop | 36 // (3.b) MessageLoop::DestructionObserver::WillDestroyCurrentMessageLoop |
35 class BASE_EXPORT Thread : PlatformThread::Delegate { | 37 class BASE_EXPORT Thread : PlatformThread::Delegate { |
36 public: | 38 public: |
37 struct BASE_EXPORT Options { | 39 struct BASE_EXPORT Options { |
38 typedef Callback<scoped_ptr<MessagePump>()> MessagePumpFactory; | 40 typedef Callback<scoped_ptr<MessagePump>()> MessagePumpFactory; |
39 | 41 |
40 Options(); | 42 Options(); |
41 Options(MessageLoop::Type type, size_t size); | 43 Options(MessageLoop::Type type, size_t size); |
42 ~Options(); | 44 ~Options(); |
43 | 45 |
44 // Specifies the type of message loop that will be allocated on the thread. | 46 // Specifies the type of message loop that will be allocated on the thread. |
45 // This is ignored if message_pump_factory.is_null() is false. | 47 // This is ignored if message_pump_factory.is_null() is false. |
46 MessageLoop::Type message_loop_type; | 48 MessageLoop::Type message_loop_type; |
47 | 49 |
48 // Specify timer slack for thread message loop. | 50 // Specifies timer slack for thread message loop. |
49 TimerSlack timer_slack; | 51 TimerSlack timer_slack; |
50 | 52 |
51 // Used to create the MessagePump for the MessageLoop. The callback is Run() | 53 // Used to create the MessagePump for the MessageLoop. The callback is Run() |
52 // on the thread. If message_pump_factory.is_null(), then a MessagePump | 54 // on the thread. If message_pump_factory.is_null(), then a MessagePump |
53 // appropriate for |message_loop_type| is created. Setting this forces the | 55 // appropriate for |message_loop_type| is created. Setting this forces the |
54 // MessageLoop::Type to TYPE_CUSTOM. | 56 // MessageLoop::Type to TYPE_CUSTOM. |
55 MessagePumpFactory message_pump_factory; | 57 MessagePumpFactory message_pump_factory; |
56 | 58 |
57 // Specifies the maximum stack size that the thread is allowed to use. | 59 // Specifies the maximum stack size that the thread is allowed to use. |
58 // This does not necessarily correspond to the thread's initial stack size. | 60 // This does not necessarily correspond to the thread's initial stack size. |
(...skipping 15 matching lines...) Expand all Loading... |
74 // before it is destructed. | 76 // before it is destructed. |
75 ~Thread() override; | 77 ~Thread() override; |
76 | 78 |
77 #if defined(OS_WIN) | 79 #if defined(OS_WIN) |
78 // Causes the thread to initialize COM. This must be called before calling | 80 // Causes the thread to initialize COM. This must be called before calling |
79 // Start() or StartWithOptions(). If |use_mta| is false, the thread is also | 81 // Start() or StartWithOptions(). If |use_mta| is false, the thread is also |
80 // started with a TYPE_UI message loop. It is an error to call | 82 // started with a TYPE_UI message loop. It is an error to call |
81 // init_com_with_mta(false) and then StartWithOptions() with any message loop | 83 // init_com_with_mta(false) and then StartWithOptions() with any message loop |
82 // type other than TYPE_UI. | 84 // type other than TYPE_UI. |
83 void init_com_with_mta(bool use_mta) { | 85 void init_com_with_mta(bool use_mta) { |
84 DCHECK(!started_); | 86 DCHECK(!start_event_); |
85 com_status_ = use_mta ? MTA : STA; | 87 com_status_ = use_mta ? MTA : STA; |
86 } | 88 } |
87 #endif | 89 #endif |
88 | 90 |
89 // Starts the thread. Returns true if the thread was successfully started; | 91 // Starts the thread. Returns true if the thread was successfully started; |
90 // otherwise, returns false. Upon successful return, the message_loop() | 92 // otherwise, returns false. Upon successful return, the message_loop() |
91 // getter will return non-null. | 93 // getter will return non-null. |
92 // | 94 // |
93 // Note: This function can't be called on Windows with the loader lock held; | 95 // Note: This function can't be called on Windows with the loader lock held; |
94 // i.e. during a DllMain, global object construction or destruction, atexit() | 96 // i.e. during a DllMain, global object construction or destruction, atexit() |
95 // callback. | 97 // callback. |
96 bool Start(); | 98 bool Start(); |
97 | 99 |
98 // Starts the thread. Behaves exactly like Start in addition to allow to | 100 // Starts the thread. Behaves exactly like Start in addition to allow to |
99 // override the default options. | 101 // override the default options. |
100 // | 102 // |
101 // Note: This function can't be called on Windows with the loader lock held; | 103 // Note: This function can't be called on Windows with the loader lock held; |
102 // i.e. during a DllMain, global object construction or destruction, atexit() | 104 // i.e. during a DllMain, global object construction or destruction, atexit() |
103 // callback. | 105 // callback. |
104 bool StartWithOptions(const Options& options); | 106 bool StartWithOptions(const Options& options); |
105 | 107 |
| 108 // Starts the thread and wait for the thread to start and run initialization |
| 109 // before returning. It's same as calling Start() and then |
| 110 // WaitUntilThreadStarted(). |
| 111 // Note that using this (instead of Start() or StartWithOptions() causes |
| 112 // jank on the calling thread, should be used only in testing code. |
| 113 bool StartAndWaitForTesting(); |
| 114 |
| 115 // Blocks until the thread starts running. Called within StartAndWait(). |
| 116 // Note that calling this causes jank on the calling thread, must be used |
| 117 // carefully for production code. |
| 118 bool WaitUntilThreadStarted(); |
| 119 |
106 // Signals the thread to exit and returns once the thread has exited. After | 120 // Signals the thread to exit and returns once the thread has exited. After |
107 // this method returns, the Thread object is completely reset and may be used | 121 // this method returns, the Thread object is completely reset and may be used |
108 // as if it were newly constructed (i.e., Start may be called again). | 122 // as if it were newly constructed (i.e., Start may be called again). |
109 // | 123 // |
110 // Stop may be called multiple times and is simply ignored if the thread is | 124 // Stop may be called multiple times and is simply ignored if the thread is |
111 // already stopped. | 125 // already stopped. |
112 // | 126 // |
113 // NOTE: If you are a consumer of Thread, it is not necessary to call this | 127 // NOTE: If you are a consumer of Thread, it is not necessary to call this |
114 // before deleting your Thread objects, as the destructor will do it. | 128 // before deleting your Thread objects, as the destructor will do it. |
115 // IF YOU ARE A SUBCLASS OF Thread, YOU MUST CALL THIS IN YOUR DESTRUCTOR. | 129 // IF YOU ARE A SUBCLASS OF Thread, YOU MUST CALL THIS IN YOUR DESTRUCTOR. |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
149 scoped_refptr<MessageLoopProxy> message_loop_proxy() const { | 163 scoped_refptr<MessageLoopProxy> message_loop_proxy() const { |
150 return message_loop_ ? message_loop_->message_loop_proxy() : NULL; | 164 return message_loop_ ? message_loop_->message_loop_proxy() : NULL; |
151 } | 165 } |
152 | 166 |
153 // Returns a TaskRunner for this thread. Use the TaskRunner's PostTask | 167 // Returns a TaskRunner for this thread. Use the TaskRunner's PostTask |
154 // methods to execute code on the thread. Returns NULL if the thread is not | 168 // methods to execute code on the thread. Returns NULL if the thread is not |
155 // running (e.g. before Start or after Stop have been called). Callers can | 169 // running (e.g. before Start or after Stop have been called). Callers can |
156 // hold on to this even after the thread is gone; in this situation, attempts | 170 // hold on to this even after the thread is gone; in this situation, attempts |
157 // to PostTask() will fail. | 171 // to PostTask() will fail. |
158 scoped_refptr<SingleThreadTaskRunner> task_runner() const { | 172 scoped_refptr<SingleThreadTaskRunner> task_runner() const { |
159 return message_loop_proxy(); | 173 return message_loop_->task_runner(); |
160 } | 174 } |
161 | 175 |
162 // Returns the name of this thread (for display in debugger too). | 176 // Returns the name of this thread (for display in debugger too). |
163 const std::string& thread_name() const { return name_; } | 177 const std::string& thread_name() const { return name_; } |
164 | 178 |
165 // The native thread handle. | 179 // The native thread handle. |
166 PlatformThreadHandle thread_handle() { return thread_; } | 180 PlatformThreadHandle thread_handle() { return thread_; } |
167 | 181 |
168 // The thread ID. | 182 // The thread ID. |
169 PlatformThreadId thread_id() const { return thread_id_; } | 183 PlatformThreadId thread_id() const { return thread_.id(); } |
170 | 184 |
171 // Returns true if the thread has been started, and not yet stopped. | 185 // Returns true if the thread has been started, and not yet stopped. |
172 bool IsRunning() const; | 186 bool IsRunning() const; |
173 | 187 |
174 // Sets the thread priority. The thread must already be started. | 188 // Sets the thread priority. The thread must already be started. |
175 void SetPriority(ThreadPriority priority); | 189 void SetPriority(ThreadPriority priority); |
176 | 190 |
177 protected: | 191 protected: |
178 // Called just prior to starting the message loop | 192 // Called just prior to starting the message loop |
179 virtual void Init() {} | 193 virtual void Init() {} |
(...skipping 21 matching lines...) Expand all Loading... |
201 #endif | 215 #endif |
202 | 216 |
203 // PlatformThread::Delegate methods: | 217 // PlatformThread::Delegate methods: |
204 void ThreadMain() override; | 218 void ThreadMain() override; |
205 | 219 |
206 #if defined(OS_WIN) | 220 #if defined(OS_WIN) |
207 // Whether this thread needs to initialize COM, and if so, in what mode. | 221 // Whether this thread needs to initialize COM, and if so, in what mode. |
208 ComStatus com_status_; | 222 ComStatus com_status_; |
209 #endif | 223 #endif |
210 | 224 |
211 // Whether we successfully started the thread. | |
212 bool started_; | |
213 | |
214 // If true, we're in the middle of stopping, and shouldn't access | 225 // If true, we're in the middle of stopping, and shouldn't access |
215 // |message_loop_|. It may non-NULL and invalid. | 226 // |message_loop_|. It may non-NULL and invalid. |
216 bool stopping_; | 227 bool stopping_; |
217 | 228 |
218 // True while inside of Run(). | 229 // True while inside of Run(). |
219 bool running_; | 230 bool running_; |
220 | 231 mutable base::Lock lock_; // Protects running_. |
221 // Used to pass data to ThreadMain. | |
222 struct StartupData; | |
223 StartupData* startup_data_; | |
224 | 232 |
225 // The thread's handle. | 233 // The thread's handle. |
226 PlatformThreadHandle thread_; | 234 PlatformThreadHandle thread_; |
227 | 235 |
228 // The thread's message loop. Valid only while the thread is alive. Set | 236 // The thread's message loop. Valid only while the thread is alive. Set |
229 // by the created thread. | 237 // by the created thread. |
230 MessageLoop* message_loop_; | 238 MessageLoop* message_loop_; |
231 | 239 |
232 // Our thread's ID. | 240 // Stores Options::timer_slack_ until the message loop has been bound to |
233 PlatformThreadId thread_id_; | 241 // a thread. |
| 242 TimerSlack message_loop_timer_slack_; |
234 | 243 |
235 // The name of the thread. Used for debugging purposes. | 244 // The name of the thread. Used for debugging purposes. |
236 std::string name_; | 245 std::string name_; |
237 | 246 |
| 247 // Non-null if the thread has successfully started. |
| 248 scoped_ptr<WaitableEvent> start_event_; |
| 249 |
238 friend void ThreadQuitHelper(); | 250 friend void ThreadQuitHelper(); |
239 | 251 |
240 DISALLOW_COPY_AND_ASSIGN(Thread); | 252 DISALLOW_COPY_AND_ASSIGN(Thread); |
241 }; | 253 }; |
242 | 254 |
243 } // namespace base | 255 } // namespace base |
244 | 256 |
245 #endif // BASE_THREADING_THREAD_H_ | 257 #endif // BASE_THREADING_THREAD_H_ |
OLD | NEW |