Implement Invalidator::Acknowledge

sync/notifier/sync_invalidation_listener.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.
 //
 // A simple wrapper around invalidation::InvalidationClient that
 // handles all the startup/shutdown details and hookups.
 
 #ifndef SYNC_NOTIFIER_SYNC_INVALIDATION_LISTENER_H_
 #define SYNC_NOTIFIER_SYNC_INVALIDATION_LISTENER_H_
 
+#include <map>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/callback_forward.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/threading/non_thread_safe.h"
+#include "base/time.h"
+#include "base/timer.h"
 #include "google/cacheinvalidation/include/invalidation-listener.h"
 #include "jingle/notifier/listener/push_client_observer.h"
 #include "sync/internal_api/public/util/weak_handle.h"
 #include "sync/notifier/invalidation_state_tracker.h"
 #include "sync/notifier/invalidator_state.h"
 #include "sync/notifier/object_id_state_map.h"
 #include "sync/notifier/state_writer.h"
 #include "sync/notifier/sync_system_resources.h"
 
 namespace buzz {
@@ skipping 38 matching lines @@
   // Calls Stop().
   virtual ~SyncInvalidationListener();
 
   // Does not take ownership of |delegate| or |state_writer|.
   // |invalidation_state_tracker| must be initialized.
   void Start(
       const CreateInvalidationClientCallback&
           create_invalidation_client_callback,
       const std::string& client_id, const std::string& client_info,
       const std::string& state,
-      const InvalidationVersionMap& initial_max_invalidation_versions,
+      const InvalidationStateMap& initial_invalidation_state_map,
       const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
       Delegate* delegate);
 
   void UpdateCredentials(const std::string& email, const std::string& token);
 
   // Update the set of object IDs that we're interested in getting
   // notifications for.  May be called at any time.
   void UpdateRegisteredIds(const ObjectIdSet& ids);
+  // TODO(dcheng): Add a comment.
+  void Acknowledge(const invalidation::ObjectId& id,
+                   const AckHandle& ack_handle);
 
   // invalidation::InvalidationListener implementation.
   virtual void Ready(
       invalidation::InvalidationClient* client) OVERRIDE;
   virtual void Invalidate(
       invalidation::InvalidationClient* client,
       const invalidation::Invalidation& invalidation,
       const invalidation::AckHandle& ack_handle) OVERRIDE;
   virtual void InvalidateUnknownVersion(
       invalidation::InvalidationClient* client,
@@ skipping 27 matching lines @@
   virtual void OnNotificationsDisabled(
       notifier::NotificationsDisabledReason reason) OVERRIDE;
   virtual void OnIncomingNotification(
       const notifier::Notification& notification) OVERRIDE;
 
   void StopForTest();
 
   void DoRegistrationUpdate();
 
  private:
+  struct QueueEntry {
+    QueueEntry(const invalidation::ObjectId& id,
+               const std::string& payload,
+               int retry_count)
+        : id(id), payload(payload), retry_count(retry_count) {
+    }
+
+    invalidation::ObjectId id;
+    std::string payload;
+    int retry_count;
+  };
+  typedef std::multimap<base::TimeTicks, QueueEntry> TimerQueue;

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

Is a multimap the right data structure here?  I would have expected a priority
queue or a heap with the next timeout to be reached on top.

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

std::priority_queue doesn't allow erasing arbitrary elements. We may be able to
eventually share the PQ implementation in net/base; however, that's probably
outside the scope of this CL.

+
   void Stop();
 
   InvalidatorState GetState() const;
 
   void EmitStateChange();
 
-  void EmitInvalidation(const ObjectIdStateMap& id_state_map);
+  void PrepareInvalidation(const ObjectIdSet& ids,
+                           const std::string& payload,
+                           invalidation::InvalidationClient* client,
+                           const invalidation::AckHandle& ack_handle);
+  void EmitInvalidation(const ObjectIdSet& ids,
+                        const std::string& payload,
+                        const AckHandleMap* const local_ack_handles,
+                        invalidation::InvalidationClient* client,
+                        const invalidation::AckHandle& ack_handle);
+  void RemitInvalidation();
+
+  base::WeakPtrFactory<SyncInvalidationListener> weak_ptr_factory_;
+  base::OneShotTimer<SyncInvalidationListener> timer_;
+  TimerQueue timer_queue_;
 
   // Owned by |sync_system_resources_|.
   notifier::PushClient* const push_client_;
   SyncSystemResources sync_system_resources_;
-  InvalidationVersionMap max_invalidation_versions_;
+  InvalidationStateMap invalidation_state_map_;
   WeakHandle<InvalidationStateTracker> invalidation_state_tracker_;
   Delegate* delegate_;
   scoped_ptr<invalidation::InvalidationClient> invalidation_client_;
   scoped_ptr<RegistrationManager> registration_manager_;
   // Stored to pass to |registration_manager_| on start.
   ObjectIdSet registered_ids_;
 
   // The states of the ticl and the push client.
   InvalidatorState ticl_state_;
   InvalidatorState push_client_state_;
 
   DISALLOW_COPY_AND_ASSIGN(SyncInvalidationListener);
 };
 
 }  // namespace syncer
 
 #endif  // SYNC_NOTIFIER_SYNC_INVALIDATION_LISTENER_H_