OLD | NEW |
(Empty) | |
| 1 // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 #ifndef BASE_TEST_SCOPED_TASK_ENVIRONMENT_H_ |
| 6 #define BASE_TEST_SCOPED_TASK_ENVIRONMENT_H_ |
| 7 |
| 8 #include "base/macros.h" |
| 9 #include "base/message_loop/message_loop.h" |
| 10 |
| 11 namespace base { |
| 12 |
| 13 class TaskScheduler; |
| 14 |
| 15 namespace test { |
| 16 |
| 17 // ScopedTaskEnvironment allows usage of these APIs within its scope: |
| 18 // - (Thread|Sequenced)TaskRunnerHandle, on the thread where it lives |
| 19 // - base/task_scheduler/post_task.h, on any thread |
| 20 // |
| 21 // Tests that need either of these APIs should instantiate a |
| 22 // ScopedTaskEnvironment. |
| 23 // |
| 24 // Tasks posted to the (Thread|Sequenced)TaskRunnerHandle run synchronously when |
| 25 // RunLoop::Run(UntilIdle) is called on the thread where the |
| 26 // ScopedTaskEnvironment lives. |
| 27 // |
| 28 // Tasks posted through base/task_scheduler/post_task.h run on dedicated threads |
| 29 // as they are posted. |
| 30 // |
| 31 // Design and future improvements documented in |
| 32 // https://docs.google.com/document/d/1QabRo8c7D9LsYY3cEcaPQbOCLo8Tu-6VLykYXyl3P
kk/edit |
| 33 class ScopedTaskEnvironment { |
| 34 public: |
| 35 ScopedTaskEnvironment(); |
| 36 |
| 37 // Runs pending (Thread|Sequenced)TaskRunnerHandle tasks and pending |
| 38 // BLOCK_SHUTDOWN TaskScheduler tasks. Then, unregisters the TaskScheduler and |
| 39 // the (Thread|Sequenced)TaskRunnerHandle. |
| 40 ~ScopedTaskEnvironment(); |
| 41 |
| 42 private: |
| 43 // Note: |message_loop_| is an implementation detail and will be replaced in |
| 44 // the future, do NOT rely on the presence of a MessageLoop beyond |
| 45 // (Thread|Sequenced)TaskRunnerHandle and RunLoop. |
| 46 MessageLoop message_loop_; |
| 47 |
| 48 const TaskScheduler* task_scheduler_ = nullptr; |
| 49 |
| 50 DISALLOW_COPY_AND_ASSIGN(ScopedTaskEnvironment); |
| 51 }; |
| 52 |
| 53 } // namespace test |
| 54 } // namespace base |
| 55 |
| 56 #endif // BASE_TEST_SCOPED_ASYNC_TASK_SCHEDULER_H_ |
OLD | NEW |