[BackgroundSync] Add browser side support for SyncRegistration.done

content/browser/background_sync/background_sync_registration_handle.h

 // Copyright 2015 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 CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_REGISTRATION_HANDLE_H_
 #define CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_REGISTRATION_HANDLE_H_
 
 #include "base/callback.h"
 #include "base/logging.h"
 #include "base/memory/weak_ptr.h"
 #include "content/browser/background_sync/background_sync_registration.h"
 #include "content/browser/background_sync/background_sync_status.h"
+#include "content/common/background_sync_service.mojom.h"
 #include "content/common/content_export.h"
 
 namespace content {
 
 class BackgroundSyncManager;
 
 // Handle to BackgroundSyncRegistration that is exposed to clients. Each
 // BackgroundSyncRegistrationHandle is given a unique handle id (by the
 // BackgroundSyncManager) which is released at destruction.
 // BackgroundSyncRegistrationHandle objects must not be used (but may be
 // destroyed) after the BackgroundSyncManager has been deleted.
 class CONTENT_EXPORT BackgroundSyncRegistrationHandle {
  public:
   using HandleId = int;
   using StatusCallback = base::Callback<void(BackgroundSyncStatus)>;
+  using StatusAndStateCallback =
+      base::Callback<void(BackgroundSyncStatus, BackgroundSyncState)>;
 
   ~BackgroundSyncRegistrationHandle();
 
   const BackgroundSyncRegistrationOptions* options() const {
     DCHECK(background_sync_manager_);
     return registration_->options();
   }
 
   BackgroundSyncState sync_state() const {
     DCHECK(background_sync_manager_);
     return registration_->sync_state();
   }
 
   // Unregisters the background sync registration.  Calls |callback|
   // with BACKGROUND_SYNC_STATUS_OK if it succeeds.
   void Unregister(int64_t service_worker_id, const StatusCallback& callback);
 
+  // Runs |callback| when the registration associated with |handle_id|
+  // completes.The provided status is BACKGROUND_SYNC_STATUS_OK if the operation
+  // succeeded. The provided state is BACKGROUND_SYNC_STATE_SUCCESS on success,
+  // BACKGRUOND_SYNC_STATE_FAILED on final failure, and
+  // BACKGROUND_SYNC_STATE_UNREGISTERED if the registration was unregistered
+  // before it could complete.

[michaeln, 2015/09/17 21:44:12]

maybe comment about what "done" means in the context of periodic vs one-time
registrations

[jkarlin, 2015/09/18 12:03:19]

Done. Added comment and DCHECK to say that this is for one-shot only.

+  void NotifyWhenDone(const StatusAndStateCallback& callback);
+
   // Returns true if the handle is backed by a BackgroundSyncRegistration in the
   // BackgroundSyncManager.
   bool IsValid() const;
 
   HandleId handle_id() const { return handle_id_; }
 
  private:
   friend class BackgroundSyncManager;
 
   BackgroundSyncRegistrationHandle(
@@ skipping 16 matching lines @@
   // This is owned by background_sync_manager_ and is valid until handle_id_ is
   // released in the destructor or background_sync_manager_ has been destroyed.
   BackgroundSyncRegistration* registration_;
 
   DISALLOW_COPY_AND_ASSIGN(BackgroundSyncRegistrationHandle);
 };
 
 }  // namespace
 
 #endif  // CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_REGISTRATION_HANDLE_H_