[SYNC] Refactor SyncSourceInfo and add support in chrome invalidation client ...

chrome/browser/sync/sessions/sync_session.h

 // Copyright (c) 2010 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 representing an attempt to synchronize the local syncable data
 // store with a sync server. A SyncSession instance is passed as a stateful
 // bundle to and from various SyncerCommands with the goal of converging the
 // client view of data with that of the server. The commands twiddle with
 // session status in response to events and hiccups along the way, set and
 // query session progress with regards to conflict resolution and applying
 // server updates, and access the SyncSessionContext for the current session
 // via SyncSession instances.
 
 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_
 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_
 #pragma once
 
+#include <string>
 #include <utility>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/scoped_ptr.h"
 #include "base/time.h"
 #include "chrome/browser/sync/sessions/ordered_commit_set.h"
 #include "chrome/browser/sync/sessions/session_state.h"
 #include "chrome/browser/sync/sessions/status_controller.h"
 #include "chrome/browser/sync/sessions/sync_session_context.h"
 #include "chrome/browser/sync/util/extensions_activity_monitor.h"
 
 namespace syncable {
 class WriteTransaction;
 }
 
 namespace browser_sync {
 class ModelSafeWorker;
 
 namespace sessions {
-typedef std::pair<sync_pb::GetUpdatesCallerInfo::GetUpdatesSource,
-    syncable::ModelTypeBitSet> SyncSourceInfo;
+// A container for the source of a sync session. This includes the update
+// source, the datatypes triggering the sync session, and possible session
+// specific payloads which should be sent to the server.
+class SyncSourceInfo {

[akalin, 2011/01/12 09:55:19]

any reason why this can't be a plain struct with public member variables?

[Nicolas Zea, 2011/01/13 19:17:30]

It seemed cleaner to me since the private members here are never updated outside
of construction time (once a SyncSourceInfo is made, it's effectively a
constant), which I think fit better with Tim's SyncSession lockbox approach..

[akalin, 2011/01/13 19:47:41]

In that case, what about a struct with const members and constructors?  You get
the same effect but less accessor boilerplate.

[Nicolas Zea, 2011/01/18 06:07:23]

I went ahead and just switched to a normal struct. Having const member caused
problems with how the object initialized and passed around.

+ public:
+  SyncSourceInfo() {}
+  SyncSourceInfo(
+      const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source,
+      const syncable::ModelTypeBitSet& types)
+      : updates_source_(updates_source), types_(types) {}
+  SyncSourceInfo(
+      const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source,
+      const syncable::ModelTypeBitSet& types,
+      const std::vector<std::string>& payloads)
+      : updates_source_(updates_source), types_(types), payloads_(payloads) {}
+
+  inline const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source()
+      const {
+    return updates_source_;
+  }
+  inline const syncable::ModelTypeBitSet& types() const {
+    return types_;
+  }
+  inline const std::vector<std::string>& payloads() const {
+    return payloads_;
+  }
+
+ private:
+  sync_pb::GetUpdatesCallerInfo::GetUpdatesSource updates_source_;
+  syncable::ModelTypeBitSet types_;
+  std::vector<std::string> payloads_;
+};
 
 class SyncSession {
  public:
   // The Delegate services events that occur during the session requiring an
   // explicit (and session-global) action, as opposed to events that are simply
   // recorded in per-session state.
   class Delegate {
    public:
     // The client was throttled and should cease-and-desist syncing activity
     // until the specified time.
@@ skipping 113 matching lines @@
 
  private:
   SyncSession* session_;
   DISALLOW_COPY_AND_ASSIGN(ScopedSetSessionWriteTransaction);
 };
 
 }  // namespace sessions
 }  // namespace browser_sync
 
 #endif  // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_