API to provide status of save page reqeusts to API.

components/offline_pages/background/request_coordinator.h

 // Copyright 2016 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 COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_COORDINATOR_H_
 #define COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_COORDINATOR_H_
 
 #include <memory>
 
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/offline_pages/background/device_conditions.h"
 #include "components/offline_pages/background/offliner.h"
 #include "components/offline_pages/background/request_coordinator_event_logger.h"
 #include "components/offline_pages/background/request_queue.h"
+#include "components/offline_pages/background/request_status.h"
 #include "components/offline_pages/background/scheduler.h"
 #include "url/gurl.h"
 
 namespace offline_pages {
 
 struct ClientId;
 class OfflinerPolicy;
 class OfflinerFactory;
 class Offliner;
 class RequestPicker;
@@ skipping 13 matching lines @@
                      std::unique_ptr<RequestQueue> queue,
                      std::unique_ptr<Scheduler> scheduler);
 
   ~RequestCoordinator() override;
 
   // Queues |request| to later load and save when system conditions allow.
   // Returns true if the page could be queued successfully.
   bool SavePageLater(
       const GURL& url, const ClientId& client_id, bool user_reqeusted);
 
+  // Callback that receives the response for GetRequestStatuses.  Client must
+  // copy the result right away, it goes out of scope at the end of the
+  // callback.
+  typedef base::Callback<void(const std::vector<RequestStatus>&)>
+             RequestStatusCallback;
+
+  // For a client namespace, get the status of all requests in the request queue
+  // for that namespace.
+  void GetRequestStatuses(
+      std::string client_namespace, RequestStatusCallback callback);

[fgorski, 2016/08/02 04:18:12]

const&, const&

[Pete Williamson, 2016/08/03 00:24:32]

Done.

+
   // Starts processing of one or more queued save page later requests.
   // Returns whether processing was started and that caller should expect
   // a callback. If processing was already active, returns false.
   bool StartProcessing(const DeviceConditions& device_conditions,
                        const base::Callback<void(bool)>& callback);
 
   // Stops the current request processing if active. This is a way for
   // caller to abort processing; otherwise, processing will complete on
   // its own. In either case, the callback will be called when processing
   // is stopped or complete.
@@ skipping 25 matching lines @@
   // the next StartProcessing() call.
   bool is_canceled() {
     return is_canceled_;
   }
 
   OfflineEventLogger* GetLogger() {
     return &event_logger_;
   }
 
  private:
+  // Receives the results of a get from the request queue, and turns that into
+  // RequestStatus objects for the caller of GetRequestStatuses.
+  void GetRequestStatusesCallback(
+      std::string client_namespace,

[fgorski, 2016/08/02 04:18:12]

const&

[Pete Williamson, 2016/08/03 00:24:31]

Done.

+      RequestStatusCallback callback,
+      RequestQueue::GetRequestsResult result,
+      const std::vector<SavePageRequest>& requests);
+
+  // Gets the result of add requests to the request queue.

[dougarnett, 2016/08/02 20:39:28]

Maybe match the previous doc style here and next one:

// Receives ... 

[Pete Williamson, 2016/08/03 00:24:31]

Done.

   void AddRequestResultCallback(RequestQueue::AddRequestResult result,
                                 const SavePageRequest& request);
 
+  // Gets the result of update and delete reqeusts to the request queue.

[dougarnett, 2016/08/02 20:39:28]

requests

[Pete Williamson, 2016/08/03 00:24:31]

Done.

   void UpdateRequestCallback(RequestQueue::UpdateRequestResult result);
 
   // Callback from the request picker when it has chosen our next request.
   void RequestPicked(const SavePageRequest& request);
 
   // Callback from the request picker when no more requests are in the queue.
   void RequestQueueEmpty();
 
   void SendRequestToOffliner(const SavePageRequest& request);
 
@@ skipping 51 matching lines @@
   base::TimeDelta offliner_timeout_;
   // Allows us to pass a weak pointer to callbacks.
   base::WeakPtrFactory<RequestCoordinator> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RequestCoordinator);
 };
 
 }  // namespace offline_pages
 
 #endif  // COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_COORDINATOR_H_