| OLD | NEW |
| (Empty) |
| 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 | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef COMPONENTS_OFFLINE_PAGES_BACKGROUND_OFFLINER_H_ | |
| 6 #define COMPONENTS_OFFLINE_PAGES_BACKGROUND_OFFLINER_H_ | |
| 7 | |
| 8 #include <string> | |
| 9 | |
| 10 #include "base/callback.h" | |
| 11 | |
| 12 namespace offline_pages { | |
| 13 | |
| 14 class SavePageRequest; | |
| 15 | |
| 16 // Interface of a class responsible for constructing an offline page given | |
| 17 // a request with a URL. | |
| 18 class Offliner { | |
| 19 public: | |
| 20 // Status of processing an offline page request. | |
| 21 // WARNING: You must update histograms.xml to match any changes made to | |
| 22 // this enum (ie, OfflinePagesBackgroundOfflinerRequestStatus histogram enum). | |
| 23 // Also update related switch code in RequestCoordinatorEventLogger. | |
| 24 enum RequestStatus { | |
| 25 // No status determined/reported yet. Interim status, not sent in callback. | |
| 26 UNKNOWN = 0, | |
| 27 // Page loaded but not (yet) saved. Interim status, not sent in callback. | |
| 28 LOADED = 1, | |
| 29 // Offline page snapshot saved. | |
| 30 SAVED = 2, | |
| 31 // RequestCoordinator canceled request. | |
| 32 REQUEST_COORDINATOR_CANCELED = 3, | |
| 33 // Prerendering was canceled. | |
| 34 PRERENDERING_CANCELED = 4, | |
| 35 // Prerendering failed to load page. | |
| 36 PRERENDERING_FAILED = 5, | |
| 37 // Failed to save loaded page. | |
| 38 SAVE_FAILED = 6, | |
| 39 // Foreground transition canceled request. | |
| 40 FOREGROUND_CANCELED = 7, | |
| 41 // RequestCoordinator canceled request attempt per time limit. | |
| 42 REQUEST_COORDINATOR_TIMED_OUT = 8, | |
| 43 // The loader did not accept/start the request. | |
| 44 PRERENDERING_NOT_STARTED = 9, | |
| 45 // Prerendering failed with hard error so should not retry the request. | |
| 46 PRERENDERING_FAILED_NO_RETRY = 10, | |
| 47 // NOTE: insert new values above this line and update histogram enum too. | |
| 48 STATUS_COUNT | |
| 49 }; | |
| 50 | |
| 51 // Reports the completion status of a request. | |
| 52 // TODO(dougarnett): consider passing back a request id instead of request. | |
| 53 typedef base::Callback<void(const SavePageRequest&, RequestStatus)> | |
| 54 CompletionCallback; | |
| 55 | |
| 56 Offliner() {} | |
| 57 virtual ~Offliner() {} | |
| 58 | |
| 59 // Processes |request| to load and save an offline page. | |
| 60 // Returns whether the request was accepted or not. |callback| is guaranteed | |
| 61 // to be called if the request was accepted and |Cancel()| is not called. | |
| 62 virtual bool LoadAndSave( | |
| 63 const SavePageRequest& request, | |
| 64 const CompletionCallback& callback) = 0; | |
| 65 | |
| 66 // Clears the currently processing request, if any, and skips running its | |
| 67 // CompletionCallback. | |
| 68 virtual void Cancel() = 0; | |
| 69 | |
| 70 // TODO(dougarnett): add policy support methods. | |
| 71 }; | |
| 72 | |
| 73 } // namespace offline_pages | |
| 74 | |
| 75 #endif // COMPONENTS_OFFLINE_PAGES_BACKGROUND_OFFLINER_H_ | |
| OLD | NEW |