Client-side changes to support retry GU.

sync/sessions/nudge_tracker.h

 // Copyright 2013 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.
 //
 // A class to track the outstanding work required to bring the client back into
 // sync with the server.
 #ifndef SYNC_SESSIONS_NUDGE_TRACKER_H_
 #define SYNC_SESSIONS_NUDGE_TRACKER_H_
 
 #include <list>
 #include <map>
 
 #include "base/compiler_specific.h"
+#include "base/time/clock.h"
 #include "sync/base/sync_export.h"
 #include "sync/internal_api/public/base/model_type.h"
 #include "sync/protocol/sync.pb.h"
 #include "sync/sessions/data_type_tracker.h"
 
 namespace syncer {
 
 class ObjectIdInvalidationMap;
 
 namespace sessions {
 
 class SYNC_EXPORT_PRIVATE NudgeTracker {
  public:
   static size_t kDefaultMaxPayloadsPerType;
 
-  NudgeTracker();
+  // Takes the ownership of |clock|.
+  explicit NudgeTracker(base::Clock* clock);
   ~NudgeTracker();
 
   // Returns true if there is a good reason for performing a sync cycle.
   // This does not take into account whether or not this is a good *time* to
   // perform a sync cycle; that's the scheduler's job.
   bool IsSyncRequired() const;
 
   // Returns true if there is a good reason for performing a get updates
   // request as part of the next sync cycle.
   bool IsGetUpdatesRequired() const;
 
-  // Tells this class that all required update fetching and committing has
+  // Return true if should perform a sync cycle for GU retry.
+  bool IsRetryRequired() const;
+
+  // Tells this class that all required update fetching or committing has
   // completed successfully.
   void RecordSuccessfulSyncCycle();
 
   // Takes note of a local change.
   void RecordLocalChange(ModelTypeSet types);
 
   // Takes note of a locally issued request to refresh a data type.
   void RecordLocalRefreshRequest(ModelTypeSet types);
 
   // Takes note of the receipt of an invalidation notice from the server.
@@ skipping 46 matching lines @@
   // Fills a ProgressMarker with single legacy notification hint expected by the
   // sync server.  Newer servers will rely on the data set by FillProtoMessage()
   // instead of this.
   void SetLegacyNotificationHint(
       ModelType type,
       sync_pb::DataTypeProgressMarker* progress) const;
 
   // Adjusts the number of hints that can be stored locally.
   void SetHintBufferSize(size_t size);
 
+  void set_next_retry_time(base::Time next_retry_time) {
+    next_retry_time_ = next_retry_time;
+  }
+
  private:
   typedef std::map<ModelType, DataTypeTracker> TypeTrackerMap;
 
+  scoped_ptr<base::Clock> clock_;
+
   TypeTrackerMap type_trackers_;
 
   // Merged updates source.  This should be obsolete, but the server still
   // relies on it for some heuristics.
   sync_pb::GetUpdatesCallerInfo::GetUpdatesSource updates_source_;
 
   // Tracks whether or not invalidations are currently enabled.
   bool invalidations_enabled_;
 
   // This flag is set if suspect that some technical malfunction or known bug
   // may have left us with some unserviced invalidations.
   //
   // Keeps track of whether or not we're fully in sync with the invalidation
   // server.  This can be false even if invalidations are enabled and working
   // correctly.  For example, until we get ack-tracking working properly, we
   // won't persist invalidations between restarts, so we may be out of sync when
   // we restart.  The only way to get back into sync is to have invalidations
   // enabled, then complete a sync cycle to make sure we're fully up to date.
   bool invalidations_out_of_sync_;
 
   size_t num_payloads_per_type_;
 
+  base::Time last_successful_sync_time_;
+
+  // A retry GU should be issued after this time.
+  base::Time next_retry_time_;
+
   DISALLOW_COPY_AND_ASSIGN(NudgeTracker);
 };
 
 }  // namespace sessions
 }  // namespace syncer
 
 #endif  // SYNC_SESSIONS_NUDGE_TRACKER_H_