Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright 2012 The Chromium Authors. All rights reserved. | 1 // Copyright 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 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 76 virtual bool ScheduleConfiguration(const ConfigurationParams& params) = 0; | 76 virtual bool ScheduleConfiguration(const ConfigurationParams& params) = 0; |
| 77 | 77 |
| 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. All three 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 | 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 | 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, | 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 | 91 // as always with delayed tasks and timers, it's possible the task gets run |
| 92 // any time after |desired_delay|. | 92 // any time after |desired_delay|. |
| 93 virtual void ScheduleNudgeAsync( | 93 virtual void ScheduleLocalNudge( |
| 94 const base::TimeDelta& desired_delay, | 94 const base::TimeDelta& desired_delay, |
| 95 NudgeSource source, | |
| 96 ModelTypeSet types, | 95 ModelTypeSet types, |
| 97 const tracked_objects::Location& nudge_location) = 0; | 96 const tracked_objects::Location& nudge_location) = 0; |
| 98 virtual void ScheduleNudgeWithStatesAsync( | 97 virtual void ScheduleLocalRefreshRequest( |
|
tim (not reviewing)
2013/05/07 20:34:13
We should update the comment here to introduce the
rlarocque
2013/05/07 21:50:57
Done.
| |
| 99 const base::TimeDelta& desired_delay, NudgeSource source, | 98 const base::TimeDelta& desired_delay, |
| 99 ModelTypeSet types, | |
| 100 const tracked_objects::Location& nudge_location) = 0; | |
| 101 virtual void ScheduleInvalidationNudge( | |
| 102 const base::TimeDelta& desired_delay, | |
| 100 const ModelTypeInvalidationMap& invalidation_map, | 103 const ModelTypeInvalidationMap& invalidation_map, |
| 101 const tracked_objects::Location& nudge_location) = 0; | 104 const tracked_objects::Location& nudge_location) = 0; |
| 102 | 105 |
| 103 // Change status of notifications in the SyncSessionContext. | 106 // Change status of notifications in the SyncSessionContext. |
| 104 virtual void SetNotificationsEnabled(bool notifications_enabled) = 0; | 107 virtual void SetNotificationsEnabled(bool notifications_enabled) = 0; |
| 105 | 108 |
| 106 virtual base::TimeDelta GetSessionsCommitDelay() const = 0; | 109 virtual base::TimeDelta GetSessionsCommitDelay() const = 0; |
| 107 | 110 |
| 108 // Called when credentials are updated by the user. | 111 // Called when credentials are updated by the user. |
| 109 virtual void OnCredentialsUpdated() = 0; | 112 virtual void OnCredentialsUpdated() = 0; |
| 110 | 113 |
| 111 // Called when the network layer detects a connection status change. | 114 // Called when the network layer detects a connection status change. |
| 112 virtual void OnConnectionStatusChange() = 0; | 115 virtual void OnConnectionStatusChange() = 0; |
| 113 }; | 116 }; |
| 114 | 117 |
| 115 } // namespace syncer | 118 } // namespace syncer |
| 116 | 119 |
| 117 #endif // SYNC_ENGINE_SYNC_SCHEDULER_H_ | 120 #endif // SYNC_ENGINE_SYNC_SCHEDULER_H_ |
| OLD | NEW |