| // Copyright 2017 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 THIRD_PARTY_BLINK_RENDERER_MODULES_BACKGROUND_FETCH_BACKGROUND_FETCH_BRIDGE_H_ |
| #define THIRD_PARTY_BLINK_RENDERER_MODULES_BACKGROUND_FETCH_BACKGROUND_FETCH_BRIDGE_H_ |
| |
| #include <memory> |
| #include "third_party/blink/public/platform/modules/background_fetch/background_fetch.mojom-blink.h" |
| #include "third_party/blink/renderer/modules/service_worker/service_worker_registration.h" |
| #include "third_party/blink/renderer/platform/heap/handle.h" |
| #include "third_party/blink/renderer/platform/supplementable.h" |
| #include "third_party/blink/renderer/platform/wtf/functional.h" |
| #include "third_party/blink/renderer/platform/wtf/text/wtf_string.h" |
| #include "third_party/blink/renderer/platform/wtf/vector.h" |
| |
| namespace blink { |
| |
| class BackgroundFetchRegistration; |
| |
| // The bridge is responsible for establishing and maintaining the Mojo |
| // connection to the BackgroundFetchService. It's keyed on an active Service |
| // Worker Registration. |
| class BackgroundFetchBridge final |
| : public GarbageCollectedFinalized<BackgroundFetchBridge>, |
| public Supplement<ServiceWorkerRegistration> { |
| USING_GARBAGE_COLLECTED_MIXIN(BackgroundFetchBridge); |
| WTF_MAKE_NONCOPYABLE(BackgroundFetchBridge); |
| |
| public: |
| static const char kSupplementName[]; |
| |
| using AbortCallback = |
| base::OnceCallback<void(mojom::blink::BackgroundFetchError)>; |
| using GetDeveloperIdsCallback = |
| base::OnceCallback<void(mojom::blink::BackgroundFetchError, |
| const Vector<String>&)>; |
| using RegistrationCallback = |
| base::OnceCallback<void(mojom::blink::BackgroundFetchError, |
| BackgroundFetchRegistration*)>; |
| using GetIconDisplaySizeCallback = base::OnceCallback<void(const WebSize&)>; |
| using UpdateUICallback = |
| base::OnceCallback<void(mojom::blink::BackgroundFetchError)>; |
| |
| static BackgroundFetchBridge* From(ServiceWorkerRegistration* registration); |
| |
| explicit BackgroundFetchBridge(ServiceWorkerRegistration& registration); |
| virtual ~BackgroundFetchBridge(); |
| |
| // Creates a new Background Fetch registration identified by |developer_id| |
| // for the sequence of |requests|. The |callback| will be invoked when the |
| // registration has been created. |
| void Fetch(const String& developer_id, |
| Vector<mojom::blink::FetchAPIRequestPtr> requests, |
| mojom::blink::BackgroundFetchOptionsPtr options, |
| const SkBitmap& icon, |
| mojom::blink::BackgroundFetchUkmDataPtr ukm_data, |
| RegistrationCallback callback); |
| |
| // Gets the size of the icon to be displayed in Background Fetch UI. |
| void GetIconDisplaySize(GetIconDisplaySizeCallback callback); |
| |
| // Matches completed requests for the fetch associated with the |developer_id| |
| // and |unique_id| and returns the {request, response} pairs based on the rest |
| // of the arguments. If |filter_by_request| is true, only response(s) for |
| // |request_to_match| are returned. |cache_query_params|s are options for the |
| // query to the cache storage. |match_all|, when true, returns all responses |
| // from the result set, and when false, returns only the first one. |
| void MatchRequests( |
| const String& developer_id, |
| const String& unique_id, |
| mojom::blink::FetchAPIRequestPtr request_to_match, |
| mojom::blink::QueryParamsPtr cache_query_params, |
| bool match_all, |
| mojom::blink::BackgroundFetchService::MatchRequestsCallback callback); |
| |
| // Updates the user interface for the Background Fetch identified by |
| // |unique_id| with the updated |title| or |icon|. Will invoke the |callback| |
| // when the interface has been requested to update. |
| void UpdateUI(const String& developer_id, |
| const String& unique_id, |
| const String& title, |
| const SkBitmap& icon, |
| UpdateUICallback callback); |
| |
| // Aborts the active Background Fetch for |unique_id|. Will invoke the |
| // |callback| when the Background Fetch identified by |unique_id| has been |
| // aborted, or could not be aborted for operational reasons. |
| void Abort(const String& developer_id, |
| const String& unique_id, |
| AbortCallback callback); |
| |
| // Gets the Background Fetch registration for the given |developer_id|. Will |
| // invoke the |callback| with the Background Fetch registration, which may be |
| // a nullptr if the |developer_id| does not exist, when the Mojo call has |
| // completed. |
| void GetRegistration(const String& developer_id, |
| RegistrationCallback callback); |
| |
| // Gets the sequence of ids for active Background Fetch registrations. Will |
| // invoke the |callback| with the |developers_id|s when the Mojo call has |
| // completed. |
| void GetDeveloperIds(GetDeveloperIdsCallback callback); |
| |
| // Registers the |observer| to receive progress events for the background |
| // fetch registration identified by the |unique_id|. |
| void AddRegistrationObserver( |
| const String& unique_id, |
| mojom::blink::BackgroundFetchRegistrationObserverPtr observer); |
| |
| private: |
| // Returns an initialized BackgroundFetchService*. A connection will be |
| // established after the first call to this method. |
| mojom::blink::BackgroundFetchService* GetService(); |
| |
| void DidGetRegistration( |
| RegistrationCallback callback, |
| mojom::blink::BackgroundFetchError error, |
| mojom::blink::BackgroundFetchRegistrationPtr registration_ptr); |
| |
| mojom::blink::BackgroundFetchServicePtr background_fetch_service_; |
| }; |
| |
| } // namespace blink |
| |
| #endif // THIRD_PARTY_BLINK_RENDERER_MODULES_BACKGROUND_FETCH_BACKGROUND_FETCH_BRIDGE_H_ |