Commit InvalidationService implementations

chrome/browser/invalidation/invalidation_frontend.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.
 
-#ifndef CHROME_BROWSER_SYNC_INVALIDATION_FRONTEND_H_
-#define CHROME_BROWSER_SYNC_INVALIDATION_FRONTEND_H_
+#ifndef CHROME_BROWSER_INVALIDATION_INVALIDATION_FRONTEND_H_
+#define CHROME_BROWSER_INVALIDATION_INVALIDATION_FRONTEND_H_

[rlarocque, 2013/04/24 20:26:15]

Note: The next patch in the series will rename this from InvalidationFrontend to
InvalidationService.  I decided to keep the existing name for now because I
don't want to touch ProfileSyncService or any of the files that treat it as an
InvalidationFrontend in this CL.

 
 #include "sync/notifier/invalidation_util.h"
+#include "sync/notifier/invalidator_state.h"
 
 namespace syncer {
 class InvalidationHandler;
+class AckHandle;
 }  // namespace syncer
 
+namespace invalidation {
+
 // Interface for classes that handle invalidation registrations and send out
 // invalidations to register handlers.
 //
 // Invalidation clients should follow the pattern below:
 //
 // When starting the client:
 //
 //   frontend->RegisterInvalidationHandler(client_handler);
 //
 // When the set of IDs to register changes for the client during its lifetime
 // (i.e., between calls to RegisterInvalidationHandler(client_handler) and
 // UnregisterInvalidationHandler(client_handler):
 //
 //   frontend->UpdateRegisteredInvalidationIds(client_handler, client_ids);
 //
-// When shutting down the client for browser shutdown:
+// To unregister for all invalidations:
 //
 //   frontend->UnregisterInvalidationHandler(client_handler);
 //
-// Note that there's no call to UpdateRegisteredIds() -- this is because the
-// invalidation API persists registrations across browser restarts.
-//
-// When permanently shutting down the client, e.g. when disabling the related
-// feature:
-//
-//   frontend->UpdateRegisteredInvalidationIds(client_handler, ObjectIdSet());
-//   frontend->UnregisterInvalidationHandler(client_handler);
-//
 // If an invalidation handler cares about the invalidator state, it should also
 // do the following when starting the client:
 //
 //   invalidator_state = frontend->GetInvalidatorState();
 //
 // It can also do the above in OnInvalidatorStateChange(), or it can use the
 // argument to OnInvalidatorStateChange().
 //
-// It is an error to have registered handlers when an
-// InvalidationFrontend is shut down; clients must ensure that they
-// unregister themselves before then. (Depending on the
-// InvalidationFrontend, shutdown may be equivalent to destruction, or
-// a separate function call like Shutdown()).
+// It is an error to have registered handlers when an InvalidationFrontend is
+// shut down; clients must ensure that they unregister themselves before then.
 //
 // NOTE(akalin): Invalidations that come in during browser shutdown may get
 // dropped.  This won't matter once we have an Acknowledge API, though: see
 // http://crbug.com/78462 and http://crbug.com/124149.
 class InvalidationFrontend {
  public:
   // Starts sending notifications to |handler|.  |handler| must not be NULL,
   // and it must not already be registered.
   //
   // Handler registrations are persisted across restarts of sync.
@@ skipping 24 matching lines @@
 
   // Returns the current invalidator state.  When called from within
   // InvalidationHandler::OnInvalidatorStateChange(), this must return
   // the updated state.
   virtual syncer::InvalidatorState GetInvalidatorState() const = 0;
 
  protected:
   virtual ~InvalidationFrontend() { }
 };
 
-#endif  // CHROME_BROWSER_SYNC_INVALIDATION_FRONTEND_H_
+}  // namespace invalidation
+
+#endif  // CHROME_BROWSER_INVALIDATION_INVALIDATION_FRONTEND_H_