[Sync] Parse and save per-data type throttle data

chrome/browser/sync/sessions/sync_session_context.h

 // Copyright (c) 2011 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.
 
 // SyncSessionContext encapsulates the contextual information and engine
 // components specific to a SyncSession. A context is accessible via
 // a SyncSession so that session SyncerCommands and parts of the engine have
 // a convenient way to access other parts. In this way it can be thought of as
 // the surrounding environment for the SyncSession. The components of this
 // environment are either valid or not valid for the entire context lifetime,
 // or they are valid for explicitly scoped periods of time by using Scoped
 // installation utilities found below. This means that the context assumes no
 // ownership whatsoever of any object that was not created by the context
 // itself.
 //
 // It can only be used from the SyncerThread.
 
 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_
 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_
 #pragma once
 
+#include <map>
 #include <string>
 
 #include "base/memory/scoped_ptr.h"
+#include "base/time.h"
 #include "chrome/browser/sync/engine/model_safe_worker.h"
 #include "chrome/browser/sync/engine/syncer_types.h"
 #include "chrome/browser/sync/sessions/debug_info_getter.h"
 
 namespace syncable {
 class DirectoryManager;
 }
 
 namespace browser_sync {
 
 class ConflictResolver;
 class ExtensionsActivityMonitor;
 class ModelSafeWorkerRegistrar;
 class ServerConnectionManager;
 
 // Default number of items a client can commit in a single message.
 static const int kDefaultMaxCommitBatchSize = 25;
 
 namespace sessions {
 class ScopedSessionContextConflictResolver;
 struct SyncSessionSnapshot;
 class TestScopedSessionEventListener;
 
+typedef std::map<syncable::ModelType, base::TimeTicks> UnthrottleTimes;

[akalin, 2011/11/21 22:36:04]

i think this can be private to SyncSessionContext

[lipalani1, 2011/11/22 00:47:36]

Done.

+
 class SyncSessionContext {
  public:
   SyncSessionContext(ServerConnectionManager* connection_manager,
                      syncable::DirectoryManager* directory_manager,
                      ModelSafeWorkerRegistrar* model_safe_worker_registrar,
                      const std::vector<SyncEngineEventListener*>& listeners,
                      DebugInfoGetter* debug_info_getter);
+
+  // Empty constructor for unit tests.
+  SyncSessionContext();
   ~SyncSessionContext();
 
   ConflictResolver* resolver() { return resolver_; }
   ServerConnectionManager* connection_manager() {
     return connection_manager_;
   }
   syncable::DirectoryManager* directory_manager() {
     return directory_manager_;
   }
   ModelSafeWorkerRegistrar* registrar() {
@@ skipping 31 matching lines @@
 
   void set_previous_session_routing_info(const ModelSafeRoutingInfo& info) {
     previous_session_routing_info_ = info;
   }
 
   void NotifyListeners(const SyncEngineEvent& event) {
     FOR_EACH_OBSERVER(SyncEngineEventListener, listeners_,
                       OnSyncEngineEvent(event));
   }
 
+  virtual void AddUnthrottleTime(const syncable::ModelTypeSet& types,

[akalin, 2011/11/21 22:36:04]

comment that it's virtual for unit tests

[akalin, 2011/11/21 22:36:04]

add a TODO to actually use the unthrottle times (for your next patch)

[akalin, 2011/11/21 22:36:04]

I think SetUnthrottleTime is a better name

[lipalani1, 2011/11/22 00:47:36]

Done.

[lipalani1, 2011/11/22 00:47:36]

Done.

[lipalani1, 2011/11/22 00:47:36]

Done.

+                                 const base::TimeTicks& time);
+
  private:
   // Rather than force clients to set and null-out various context members, we
   // extend our encapsulation boundary to scoped helpers that take care of this
   // once they are allocated. See definitions of these below.
   friend class ScopedSessionContextConflictResolver;
   friend class TestScopedSessionEventListener;
 
   // This is installed by Syncer objects when needed and may be NULL.
   ConflictResolver* resolver_;
 
@@ skipping 24 matching lines @@
   // by the user.
   ModelSafeRoutingInfo previous_session_routing_info_;
 
   // Cache of last session snapshot information.
   scoped_ptr<sessions::SyncSessionSnapshot> previous_session_snapshot_;
 
   // We use this to get debug info to send to the server for debugging
   // client behavior on server side.
   DebugInfoGetter* const debug_info_getter_;
 
+  UnthrottleTimes unthrottle_times_;

[akalin, 2011/11/21 22:36:04]

add comment saying that this is a map from throttled data types to the time at
which they can be unthrottled.

[lipalani1, 2011/11/22 00:47:36]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(SyncSessionContext);
 };
 
 // Installs a ConflictResolver to a given session context for the lifetime of
 // the ScopedSessionContextConflictResolver.  There should never be more than
 // one ConflictResolver in the system, so it is an error to use this if the
 // context already has a resolver.
 class ScopedSessionContextConflictResolver {
  public:
   // Note: |context| and |resolver| should outlive |this|.
   ScopedSessionContextConflictResolver(SyncSessionContext* context,
                                        ConflictResolver* resolver)
       : context_(context), resolver_(resolver) {
     DCHECK(NULL == context->resolver_);
     context->resolver_ = resolver;
   }
   ~ScopedSessionContextConflictResolver() {
     context_->resolver_ = NULL;
    }
  private:
   SyncSessionContext* context_;
   ConflictResolver* resolver_;
   DISALLOW_COPY_AND_ASSIGN(ScopedSessionContextConflictResolver);
 };
 
 }  // namespace sessions
 }  // namespace browser_sync
 
 #endif  // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_CONTEXT_H_