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"
@@ skipping 32 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 GetQueuedRequests.  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<ClientId>&)>
+      QueuedRequestCallback;
+
+  // For a client namespace, get the client_id of all requests for that

[dougarnett, 2016/08/03 04:27:19]

for comment probably better "client_id" => "client id" or "ClientId"

[Pete Williamson, 2016/08/03 20:13:44]

Done.

+  // namespace.
+  void GetQueuedRequests(const std::string& client_namespace,
+                         const QueuedRequestCallback& callback);
+
   // 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
+  // ClientId objects for the caller of GetQueuedRequests.
+  void GetQueuedRequestsCallback(const std::string& client_namespace,
+                                 QueuedRequestCallback callback,

[fgorski, 2016/08/03 03:13:15]

const &

[Pete Williamson, 2016/08/03 20:13:44]

Done.

+                                 RequestQueue::GetRequestsResult result,
+                                 const std::vector<SavePageRequest>& requests);
+
+  // Receives the result of add requests to the request queue.
   void AddRequestResultCallback(RequestQueue::AddRequestResult result,
                                 const SavePageRequest& request);
 
+  // Receives the result of update and delete requests to the request queue.
   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_