Implement Invalidator::Acknowledge

sync/notifier/invalidation_state_tracker.h

 // Copyright (c) 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.
 //
-// An InvalidationVersionTracker is an interface that handles getting
-// and setting (persisting) max invalidation versions.
+// An InvalidationStateTracker is an interface that handles getting
+// and setting (persisting) max invalidation versions and our local ack
+// handles.
 
 #ifndef SYNC_NOTIFIER_INVALIDATION_STATE_TRACKER_H_
 #define SYNC_NOTIFIER_INVALIDATION_STATE_TRACKER_H_
 
+#include <string>
 #include <map>
 
 #include "base/basictypes.h"
 #include "google/cacheinvalidation/include/types.h"
+#include "sync/internal_api/public/base/invalidation_state.h"
 #include "sync/notifier/invalidation_util.h"
 
 namespace syncer {
 
-typedef std::map<invalidation::ObjectId, int64, ObjectIdLessThan>
-    InvalidationVersionMap;
+// TODO(dcheng): Need a better name.
+struct LocalState {

[Pete Williamson, 2012/09/14 18:28:22]

ObjectVersionReportingState?
InvalidationVersionState?
MessageForReplay?

[dcheng, 2012/09/14 19:08:49]

What about "VersionData"?

+  LocalState();
+  ~LocalState();
+
+  int64 version;
+  std::string payload;
+  AckHandle expected;
+  AckHandle current;
+};
+
+typedef std::map<invalidation::ObjectId, LocalState, ObjectIdLessThan>
+    InvalidationStateMap;
+typedef std::map<invalidation::ObjectId, AckHandle, ObjectIdLessThan>
+    AckHandleMap;

[Pete Williamson, 2012/09/14 18:28:22]

Why this second map?  The first map already has the AckHandle.

[dcheng, 2012/09/14 19:08:49]

For GenerateAckHandles. The first one is currently only used for persisting the
data.

I think passing a pointer to the in-memory InvalidationStateMap* in
SyncInvalidationListener would probably not work as well, since it's possible
there are multiple requests in flight so we'd have to make a copy each time.

 
 class InvalidationStateTracker {
  public:
   InvalidationStateTracker() {}
 
-  virtual InvalidationVersionMap GetAllMaxVersions() const = 0;
+  virtual InvalidationStateMap GetStateMap() const = 0;
 
   // |max_version| should be strictly greater than any existing max
   // version for |model_type|.
   virtual void SetMaxVersion(const invalidation::ObjectId& id,
                              int64 max_version) = 0;
   // Removes all state tracked for |ids|.
   virtual void Forget(const ObjectIdSet& ids) = 0;
 
   // Used by InvalidationClient for persistence. |state| is opaque data we can
   // present back to the client (e.g. after a restart) for it to bootstrap
   // itself.
   // |state| is plain old data (not valid UTF8, embedded nulls, etc).
   virtual void SetInvalidationState(const std::string& state) = 0;
   virtual std::string GetInvalidationState() const = 0;
 
+  // Used for generating our own local ack handles.
+  // Generates a new ack handle for each object id in |ids|. The resulting ack
+  // handles are passed back in the output parameter rather than being returned
+  // directly, since this method is typically used with PostTaskAndReply.
+  virtual void GenerateAckHandles(const ObjectIdSet& ids,
+                                  AckHandleMap* ack_handles) = 0;
+  virtual void Acknowledge(const invalidation::ObjectId& id,
+                           const AckHandle& ack_handle) = 0;
+
  protected:
   virtual ~InvalidationStateTracker() {}
 };
 
 }  // namespace syncer
 
 #endif  // SYNC_NOTIFIER_INVALIDATION_STATE_TRACKER_H_