OLD | NEW |
1 // Copyright (c) 2010 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_THREADING_WORKER_POOL_H_ | 5 #ifndef BASE_THREADING_WORKER_POOL_H_ |
6 #define BASE_THREADING_WORKER_POOL_H_ | 6 #define BASE_THREADING_WORKER_POOL_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
| 9 #include "base/base_api.h" |
9 #include "base/tracked.h" | 10 #include "base/tracked.h" |
10 | 11 |
11 class Task; | 12 class Task; |
12 | 13 |
13 namespace base { | 14 namespace base { |
14 | 15 |
15 // This is a facility that runs tasks that don't require a specific thread or | 16 // This is a facility that runs tasks that don't require a specific thread or |
16 // a message loop. | 17 // a message loop. |
17 // | 18 // |
18 // WARNING: This shouldn't be used unless absolutely necessary. We don't wait | 19 // WARNING: This shouldn't be used unless absolutely necessary. We don't wait |
19 // for the worker pool threads to finish on shutdown, so the tasks running | 20 // for the worker pool threads to finish on shutdown, so the tasks running |
20 // inside the pool must be extremely careful about other objects they access | 21 // inside the pool must be extremely careful about other objects they access |
21 // (MessageLoops, Singletons, etc). During shutdown these object may no longer | 22 // (MessageLoops, Singletons, etc). During shutdown these object may no longer |
22 // exist. | 23 // exist. |
23 class WorkerPool { | 24 class BASE_API WorkerPool { |
24 public: | 25 public: |
25 // This function posts |task| to run on a worker thread. |task_is_slow| | 26 // This function posts |task| to run on a worker thread. |task_is_slow| |
26 // should be used for tasks that will take a long time to execute. Returns | 27 // should be used for tasks that will take a long time to execute. Returns |
27 // false if |task| could not be posted to a worker thread. Regardless of | 28 // false if |task| could not be posted to a worker thread. Regardless of |
28 // return value, ownership of |task| is transferred to the worker pool. | 29 // return value, ownership of |task| is transferred to the worker pool. |
29 static bool PostTask(const tracked_objects::Location& from_here, | 30 static bool PostTask(const tracked_objects::Location& from_here, |
30 Task* task, bool task_is_slow); | 31 Task* task, bool task_is_slow); |
31 }; | 32 }; |
32 | 33 |
33 } // namespace base | 34 } // namespace base |
34 | 35 |
35 #endif // BASE_THREADING_WORKER_POOL_H_ | 36 #endif // BASE_THREADING_WORKER_POOL_H_ |
OLD | NEW |