Client-side changes to support retry GU.

sync/engine/sync_scheduler_impl.h

 // Copyright 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef SYNC_ENGINE_SYNC_SCHEDULER_IMPL_H_
 #define SYNC_ENGINE_SYNC_SCHEDULER_IMPL_H_
 
 #include <map>
 #include <string>
 
@@ skipping 71 matching lines @@
   virtual bool IsCurrentlyThrottled() OVERRIDE;
   virtual void OnReceivedShortPollIntervalUpdate(
       const base::TimeDelta& new_interval) OVERRIDE;
   virtual void OnReceivedLongPollIntervalUpdate(
       const base::TimeDelta& new_interval) OVERRIDE;
   virtual void OnReceivedSessionsCommitDelay(
       const base::TimeDelta& new_delay) OVERRIDE;
   virtual void OnReceivedClientInvalidationHintBufferSize(int size) OVERRIDE;
   virtual void OnSyncProtocolError(
       const sessions::SyncSessionSnapshot& snapshot) OVERRIDE;
+  virtual void OnReceivedGuRetryDelay(const base::TimeDelta& delay) OVERRIDE;
+
+  // Returns true if the client is currently in exponential backoff.
+  bool IsBackingOff() const;
 
  private:
   enum JobPriority {
     // Non-canary jobs respect exponential backoff.
     NORMAL_PRIORITY,
     // Canary jobs bypass exponential backoff, so use with extreme caution.
     CANARY_PRIORITY
   };
 
   enum PollAdjustType {
@@ skipping 58 matching lines @@
   // Invoke the syncer to perform a configuration job.
   void DoConfigurationSyncSessionJob(JobPriority priority);
 
   // Helper function for Do{Nudge,Configuration}SyncSessionJob.
   void HandleFailure(
       const sessions::ModelNeutralState& model_neutral_state);
 
   // Invoke the Syncer to perform a poll job.
   void DoPollSyncSessionJob();
 
+  // Invoke the Syncer to perform a retry job.
+  void DoRetrySyncSessionJob();
+
   // Helper function to calculate poll interval.
   base::TimeDelta GetPollInterval();
 
   // Adjusts the poll timer to account for new poll interval, and possibly
   // resets the poll interval, depedning on the flag's value.
   void AdjustPolling(PollAdjustType type);
 
   // Helper to restart waiting with |wait_interval_|'s timer.
   void RestartWaiting();
 
   // Determines if we're allowed to contact the server right now.
   bool CanRunJobNow(JobPriority priority);
 
   // Determines if we're allowed to contact the server right now.
   bool CanRunNudgeJobNow(JobPriority priority);
 
   // If the scheduler's current state supports it, this will create a job based
   // on the passed in parameters and coalesce it with any other pending jobs,
   // then post a delayed task to run it.  It may also choose to drop the job or
   // save it for later, depending on the scheduler's current state.
   void ScheduleNudgeImpl(
       const base::TimeDelta& delay,
       const tracked_objects::Location& nudge_location);
 
-  // Returns true if the client is currently in exponential backoff.
-  bool IsBackingOff() const;
-
   // Helper to signal all listeners registered with |session_context_|.
   void Notify(SyncEngineEvent::EventCause cause);
 
   // Helper to signal listeners about changed retry time.
   void NotifyRetryTime(base::Time retry_time);
 
   // Helper to signal listeners about changed throttled types.
   void NotifyThrottledTypesChanged(ModelTypeSet types);
 
   // Looks for pending work and, if it finds any, run this work at "canary"
@@ skipping 16 matching lines @@
 
   // Attempts to exit EXPONENTIAL_BACKOFF by calling TryCanaryJob().
   void ExponentialBackoffRetry();
 
   // Called when the root cause of the current connection error is fixed.
   void OnServerConnectionErrorFixed();
 
   // Creates a session for a poll and performs the sync.
   void PollTimerCallback();
 
+  // Creates a session for a retry and performs the sync.
+  void RetryTimerCallback();
+
   // Returns the set of types that are enabled and not currently throttled.
   ModelTypeSet GetEnabledAndUnthrottledTypes();
 
   // Called as we are started to broadcast an initial session snapshot
   // containing data like initial_sync_ended.  Important when the client starts
   // up and does not need to perform an initial sync.
   void SendInitialSnapshot();
 
   // This is used for histogramming and analysis of ScheduleNudge* APIs.
   // SyncScheduler is the ultimate choke-point for all such invocations (with
@@ skipping 86 matching lines @@
   // after NETWORK_UNAVAILABLE error).
   // It is reset back to NORMAL_PRIORITY on every call to TrySyncSessionJobImpl.
   JobPriority next_sync_session_job_priority_;
 
   base::WeakPtrFactory<SyncSchedulerImpl> weak_ptr_factory_;
 
   // A second factory specially for weak_handle_this_, to allow the handle
   // to be const and alleviate threading concerns.
   base::WeakPtrFactory<SyncSchedulerImpl> weak_ptr_factory_for_weak_handle_;
 
+  // One-shot timer for scheduling GU retry according to delay set by server.
+  base::OneShotTimer<SyncSchedulerImpl> retry_timer_;
+
   DISALLOW_COPY_AND_ASSIGN(SyncSchedulerImpl);
 };
 
 }  // namespace syncer
 
 #endif  // SYNC_ENGINE_SYNC_SCHEDULER_IMPL_H_