| OLD | NEW |
| 1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ | 5 #ifndef COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ |
| 6 #define COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ | 6 #define COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ |
| 7 | 7 |
| 8 #include <stdint.h> | 8 #include <stdint.h> |
| 9 | 9 |
| 10 #include <memory> | 10 #include <memory> |
| (...skipping 25 matching lines...) Expand all Loading... |
| 36 // reached a quota of active requests. | 36 // reached a quota of active requests. |
| 37 }; | 37 }; |
| 38 | 38 |
| 39 enum class UpdateRequestResult { | 39 enum class UpdateRequestResult { |
| 40 SUCCESS, | 40 SUCCESS, |
| 41 STORE_FAILURE, | 41 STORE_FAILURE, |
| 42 REQUEST_DOES_NOT_EXIST, // Failed to delete the request because it does not | 42 REQUEST_DOES_NOT_EXIST, // Failed to delete the request because it does not |
| 43 // exist. | 43 // exist. |
| 44 }; | 44 }; |
| 45 | 45 |
| 46 // Type for a pair of request_id and result. |
| 47 typedef std::vector<std::pair<int64_t, UpdateRequestResult>> |
| 48 UpdateMultipleRequestResults; |
| 49 |
| 46 // Callback used for |GetRequests|. | 50 // Callback used for |GetRequests|. |
| 47 typedef base::Callback<void(GetRequestsResult, | 51 typedef base::Callback<void(GetRequestsResult, |
| 48 const std::vector<SavePageRequest>&)> | 52 const std::vector<SavePageRequest>&)> |
| 49 GetRequestsCallback; | 53 GetRequestsCallback; |
| 50 | 54 |
| 51 // Callback used for |AddRequest|. | 55 // Callback used for |AddRequest|. |
| 52 typedef base::Callback<void(AddRequestResult, const SavePageRequest& request)> | 56 typedef base::Callback<void(AddRequestResult, const SavePageRequest& request)> |
| 53 AddRequestCallback; | 57 AddRequestCallback; |
| 54 | 58 |
| 55 // Callback used by |UdpateRequest| and |RemoveRequest|. | 59 // Callback used by |UdpateRequest|. |
| 56 typedef base::Callback<void(UpdateRequestResult)> UpdateRequestCallback; | 60 typedef base::Callback<void(UpdateRequestResult)> UpdateRequestCallback; |
| 57 | 61 |
| 62 // Callback used by |RemoveRequests|. |
| 63 typedef base::Callback<void(const UpdateMultipleRequestResults& results)> |
| 64 RemoveRequestsCallback; |
| 65 |
| 58 explicit RequestQueue(std::unique_ptr<RequestQueueStore> store); | 66 explicit RequestQueue(std::unique_ptr<RequestQueueStore> store); |
| 59 ~RequestQueue(); | 67 ~RequestQueue(); |
| 60 | 68 |
| 61 // Gets all of the active requests from the store. Calling this method may | 69 // Gets all of the active requests from the store. Calling this method may |
| 62 // schedule purging of the request queue. | 70 // schedule purging of the request queue. |
| 63 void GetRequests(const GetRequestsCallback& callback); | 71 void GetRequests(const GetRequestsCallback& callback); |
| 64 | 72 |
| 65 // Adds |request| to the request queue. Result is returned through |callback|. | 73 // Adds |request| to the request queue. Result is returned through |callback|. |
| 66 // In case adding the request violates policy, the result will fail with | 74 // In case adding the request violates policy, the result will fail with |
| 67 // appropriate result. Callback will also return a copy of a request with all | 75 // appropriate result. Callback will also return a copy of a request with all |
| 68 // fields set. | 76 // fields set. |
| 69 void AddRequest(const SavePageRequest& request, | 77 void AddRequest(const SavePageRequest& request, |
| 70 const AddRequestCallback& callback); | 78 const AddRequestCallback& callback); |
| 71 | 79 |
| 72 // Updates a request in the request queue if a request with matching ID | 80 // Updates a request in the request queue if a request with matching ID |
| 73 // exists. Does nothing otherwise. Result is returned through |callback|. | 81 // exists. Does nothing otherwise. Result is returned through |callback|. |
| 74 void UpdateRequest(const SavePageRequest& request, | 82 void UpdateRequest(const SavePageRequest& request, |
| 75 const UpdateRequestCallback& callback); | 83 const UpdateRequestCallback& callback); |
| 76 | 84 |
| 77 // Removes the request matching the |request_id|. Result is returned through | 85 // Removes the requests matching the |request_ids|. Result is returned through |
| 78 // |callback|. | 86 // |callback|. If a request id cannot be removed, this will still remove the |
| 79 void RemoveRequest(int64_t request_id, const UpdateRequestCallback& callback); | 87 // others. |
| 80 | 88 void RemoveRequests(const std::vector<int64_t>& request_ids, |
| 81 // Removes the requests matching the |client_ids|. Results are returned | 89 const RemoveRequestsCallback& callback); |
| 82 // through |callback|. | |
| 83 void RemoveRequestsByClientId(const std::vector<ClientId>& client_id, | |
| 84 const UpdateRequestCallback& callback); | |
| 85 | 90 |
| 86 void GetForUpdateDone( | 91 void GetForUpdateDone( |
| 87 const RequestQueue::UpdateRequestCallback& update_callback, | 92 const RequestQueue::UpdateRequestCallback& update_callback, |
| 88 const SavePageRequest& update_request, | 93 const SavePageRequest& update_request, |
| 89 bool success, | 94 bool success, |
| 90 const std::vector<SavePageRequest>& requests); | 95 const std::vector<SavePageRequest>& requests); |
| 91 | 96 |
| 92 private: | 97 private: |
| 93 // Callback used by |PurgeRequests|. | 98 // Callback used by |PurgeRequests|. |
| 94 typedef base::Callback<void(UpdateRequestResult, | 99 typedef base::Callback<void(UpdateRequestResult, |
| 95 int /* removed requests count */)> | 100 int /* removed requests count */)> |
| 96 PurgeRequestsCallback; | 101 PurgeRequestsCallback; |
| 97 | 102 |
| 98 // Purges the queue, removing the requests that are no longer relevant, e.g. | 103 // Purges the queue, removing the requests that are no longer relevant, e.g. |
| 99 // expired request. Result is returned through |callback| carries the number | 104 // expired request. Result is returned through |callback| carries the number |
| 100 // of removed requests. | 105 // of removed requests. |
| 101 void PurgeRequests(const PurgeRequestsCallback& callback); | 106 void PurgeRequests(const PurgeRequestsCallback& callback); |
| 102 | 107 |
| 103 std::unique_ptr<RequestQueueStore> store_; | 108 std::unique_ptr<RequestQueueStore> store_; |
| 104 | 109 |
| 105 // Allows us to pass a weak pointer to callbacks. | 110 // Allows us to pass a weak pointer to callbacks. |
| 106 base::WeakPtrFactory<RequestQueue> weak_ptr_factory_; | 111 base::WeakPtrFactory<RequestQueue> weak_ptr_factory_; |
| 107 | 112 |
| 108 DISALLOW_COPY_AND_ASSIGN(RequestQueue); | 113 DISALLOW_COPY_AND_ASSIGN(RequestQueue); |
| 109 }; | 114 }; |
| 110 | 115 |
| 111 } // namespace offline_pages | 116 } // namespace offline_pages |
| 112 | 117 |
| 113 #endif // COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ | 118 #endif // COMPONENTS_OFFLINE_PAGES_BACKGROUND_REQUEST_QUEUE_H_ |
| OLD | NEW |