OLD | NEW |
---|---|
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 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_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ | 5 #ifndef BASE_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ |
6 #define BASE_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ | 6 #define BASE_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ |
7 | 7 |
8 #include <stdint.h> | 8 #include <stdint.h> |
9 | 9 |
10 #include <memory> | 10 #include <memory> |
11 #include <queue> | 11 #include <queue> |
12 #include <vector> | 12 #include <vector> |
13 | 13 |
14 #include "base/base_export.h" | 14 #include "base/base_export.h" |
15 #include "base/callback.h" | 15 #include "base/callback.h" |
16 #include "base/macros.h" | 16 #include "base/macros.h" |
17 #include "base/memory/ref_counted.h" | 17 #include "base/memory/ref_counted.h" |
18 #include "base/task_scheduler/scheduler_lock.h" | 18 #include "base/task_scheduler/scheduler_lock.h" |
19 #include "base/task_scheduler/sequence.h" | 19 #include "base/task_scheduler/sequence.h" |
20 #include "base/task_scheduler/task.h" | 20 #include "base/task_scheduler/task.h" |
21 #include "base/time/time.h" | 21 #include "base/time/time.h" |
22 | 22 |
23 namespace base { | 23 namespace base { |
24 namespace internal { | 24 namespace internal { |
25 | 25 |
26 class SchedulerTaskExecutor; | 26 class SchedulerThreadPool; |
27 | 27 |
28 // A DelayedTaskManager holds delayed Tasks until they become ripe for | 28 // A DelayedTaskManager holds delayed Tasks until they become ripe for |
29 // execution. When they become ripe for execution, it posts them to their | 29 // execution. When they become ripe for execution, it posts them to their |
30 // associated Sequence and SchedulerTaskExecutor. This class is thread-safe. | 30 // associated Sequence and SchedulerThreadPool. This class is thread-safe. |
31 class BASE_EXPORT DelayedTaskManager { | 31 class BASE_EXPORT DelayedTaskManager { |
32 public: | 32 public: |
33 // |on_delayed_run_time_updated| is invoked when the delayed run time is | 33 // |on_delayed_run_time_updated| is invoked when the delayed run time is |
34 // updated as a result of adding a delayed task to the manager. | 34 // updated as a result of adding a delayed task to the manager. |
35 explicit DelayedTaskManager(const Closure& on_delayed_run_time_updated); | 35 explicit DelayedTaskManager(const Closure& on_delayed_run_time_updated); |
36 ~DelayedTaskManager(); | 36 ~DelayedTaskManager(); |
37 | 37 |
38 // Adds |task| to a queue of delayed tasks. The task will be posted to | 38 // Adds |task| to a queue of delayed tasks. The task will be posted to |
39 // |executor| as part of |sequence| the first time that PostReadyTasks() is | 39 // |thread_pool| as part of |sequence| the first time that PostReadyTasks() is |
40 // called while Now() is passed |task->delayed_run_time|. | 40 // called while Now() is passed |task->delayed_run_time|. |
41 // | 41 // |
42 // TODO(robliao): Find a concrete way to manage |executor|'s memory. It is | 42 // TODO(robliao): Find a concrete way to manage |thread_pool|'s memory. It is |
43 // never deleted in production, but it is better not to spread this assumption | 43 // never deleted in production, but it is better not to spread this assumption |
44 // throughout the scheduler. | 44 // throughout the scheduler. |
45 void AddDelayedTask(std::unique_ptr<Task> task, | 45 void AddDelayedTask(std::unique_ptr<Task> task, |
46 scoped_refptr<Sequence> sequence, | 46 scoped_refptr<Sequence> sequence, |
47 SchedulerTaskExecutor* executor); | 47 SchedulerThreadPool* thread_pool); |
48 | 48 |
49 // Posts delayed tasks that are ripe for execution. | 49 // Posts delayed tasks that are ripe for execution. |
50 // TODO(robliao): Call this from a service thread. | 50 // TODO(robliao): Call this from a service thread. |
51 void PostReadyTasks(); | 51 void PostReadyTasks(); |
52 | 52 |
53 // Returns the next time at which a delayed task will become ripe for | 53 // Returns the next time at which a delayed task will become ripe for |
54 // execution, or a null TimeTicks if there are no pending delayed tasks. | 54 // execution, or a null TimeTicks if there are no pending delayed tasks. |
55 TimeTicks GetDelayedRunTime() const; | 55 TimeTicks GetDelayedRunTime() const; |
56 | 56 |
57 // Returns the current time. Can be overridden for tests. | |
58 virtual TimeTicks Now() const; | |
robliao
2016/04/22 22:56:41
I probably missed it, but can this be made private
fdoray
2016/04/25 15:19:12
Can't be private because it's used here https://co
robliao
2016/04/25 20:08:09
Gotcha. One of these days, we should look into ind
| |
59 | |
57 private: | 60 private: |
58 struct DelayedTask; | 61 struct DelayedTask; |
59 struct DelayedTaskComparator { | 62 struct DelayedTaskComparator { |
60 bool operator()(const DelayedTask& left, const DelayedTask& right) const; | 63 bool operator()(const DelayedTask& left, const DelayedTask& right) const; |
61 }; | 64 }; |
62 | 65 |
63 // Returns the current time. Can be overridden for tests. | |
64 virtual TimeTicks Now() const; | |
65 | |
66 const Closure on_delayed_run_time_updated_; | 66 const Closure on_delayed_run_time_updated_; |
67 | 67 |
68 // Synchronizes access to all members below. | 68 // Synchronizes access to all members below. |
69 mutable SchedulerLock lock_; | 69 mutable SchedulerLock lock_; |
70 | 70 |
71 // Priority queue of delayed tasks. The delayed task with the smallest | 71 // Priority queue of delayed tasks. The delayed task with the smallest |
72 // |task->delayed_run_time| is in front of the priority queue. | 72 // |task->delayed_run_time| is in front of the priority queue. |
73 using DelayedTaskQueue = std::priority_queue<DelayedTask, | 73 using DelayedTaskQueue = std::priority_queue<DelayedTask, |
74 std::vector<DelayedTask>, | 74 std::vector<DelayedTask>, |
75 DelayedTaskComparator>; | 75 DelayedTaskComparator>; |
76 DelayedTaskQueue delayed_tasks_; | 76 DelayedTaskQueue delayed_tasks_; |
77 | 77 |
78 // The index to assign to the next delayed task added to the manager. | 78 // The index to assign to the next delayed task added to the manager. |
79 uint64_t delayed_task_index_ = 0; | 79 uint64_t delayed_task_index_ = 0; |
80 | 80 |
81 DISALLOW_COPY_AND_ASSIGN(DelayedTaskManager); | 81 DISALLOW_COPY_AND_ASSIGN(DelayedTaskManager); |
82 }; | 82 }; |
83 | 83 |
84 } // namespace internal | 84 } // namespace internal |
85 } // namespace base | 85 } // namespace base |
86 | 86 |
87 #endif // BASE_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ | 87 #endif // BASE_TASK_SCHEDULER_DELAYED_TASK_MANAGER_H_ |
OLD | NEW |