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 // A class to schedule syncer tasks intelligently. | 5 // A class to schedule syncer tasks intelligently. |
6 #ifndef SYNC_ENGINE_SYNC_SCHEDULER_H_ | 6 #ifndef SYNC_ENGINE_SYNC_SCHEDULER_H_ |
7 #define SYNC_ENGINE_SYNC_SCHEDULER_H_ | 7 #define SYNC_ENGINE_SYNC_SCHEDULER_H_ |
8 | 8 |
9 #include <string> | 9 #include <string> |
10 | 10 |
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
78 // Request that any running syncer task stop as soon as possible and | 78 // Request that any running syncer task stop as soon as possible and |
79 // cancel all scheduled tasks. This function can be called from any thread, | 79 // cancel all scheduled tasks. This function can be called from any thread, |
80 // and should in fact be called from a thread that isn't the sync loop to | 80 // and should in fact be called from a thread that isn't the sync loop to |
81 // allow preempting ongoing sync cycles. | 81 // allow preempting ongoing sync cycles. |
82 // Invokes |callback| from the sync loop once syncer is idle and all tasks | 82 // Invokes |callback| from the sync loop once syncer is idle and all tasks |
83 // are cancelled. | 83 // are cancelled. |
84 virtual void RequestStop(const base::Closure& callback) = 0; | 84 virtual void RequestStop(const base::Closure& callback) = 0; |
85 | 85 |
86 // The meat and potatoes. Both of these methods will post a delayed task | 86 // The meat and potatoes. Both of these methods will post a delayed task |
87 // to attempt the actual nudge (see ScheduleNudgeImpl). | 87 // to attempt the actual nudge (see ScheduleNudgeImpl). |
| 88 // NOTE: |desired_delay| is best-effort. If a nudge is already scheduled to |
| 89 // depart earlier than Now() + delay, the scheduler can and will prefer to |
| 90 // batch the two so that only one nudge is sent (at the earlier time). Also, |
| 91 // as always with delayed tasks and timers, it's possible the task gets run |
| 92 // any time after |desired_delay|. |
88 virtual void ScheduleNudgeAsync( | 93 virtual void ScheduleNudgeAsync( |
89 const base::TimeDelta& delay, | 94 const base::TimeDelta& desired_delay, |
90 NudgeSource source, | 95 NudgeSource source, |
91 ModelTypeSet types, | 96 ModelTypeSet types, |
92 const tracked_objects::Location& nudge_location) = 0; | 97 const tracked_objects::Location& nudge_location) = 0; |
93 virtual void ScheduleNudgeWithStatesAsync( | 98 virtual void ScheduleNudgeWithStatesAsync( |
94 const base::TimeDelta& delay, NudgeSource source, | 99 const base::TimeDelta& desired_delay, NudgeSource source, |
95 const ModelTypeInvalidationMap& invalidation_map, | 100 const ModelTypeInvalidationMap& invalidation_map, |
96 const tracked_objects::Location& nudge_location) = 0; | 101 const tracked_objects::Location& nudge_location) = 0; |
97 | 102 |
98 // Change status of notifications in the SyncSessionContext. | 103 // Change status of notifications in the SyncSessionContext. |
99 virtual void SetNotificationsEnabled(bool notifications_enabled) = 0; | 104 virtual void SetNotificationsEnabled(bool notifications_enabled) = 0; |
100 | 105 |
101 virtual base::TimeDelta GetSessionsCommitDelay() const = 0; | 106 virtual base::TimeDelta GetSessionsCommitDelay() const = 0; |
102 | 107 |
103 // Called when credentials are updated by the user. | 108 // Called when credentials are updated by the user. |
104 virtual void OnCredentialsUpdated() = 0; | 109 virtual void OnCredentialsUpdated() = 0; |
105 | 110 |
106 // Called when the network layer detects a connection status change. | 111 // Called when the network layer detects a connection status change. |
107 virtual void OnConnectionStatusChange() = 0; | 112 virtual void OnConnectionStatusChange() = 0; |
108 }; | 113 }; |
109 | 114 |
110 } // namespace syncer | 115 } // namespace syncer |
111 | 116 |
112 #endif // SYNC_ENGINE_SYNC_SCHEDULER_H_ | 117 #endif // SYNC_ENGINE_SYNC_SCHEDULER_H_ |
OLD | NEW |