blob: 09f1efc542af769ecc5c7cdb94a2ded403e558eb [file] [log] [blame]
// Copyright 2014 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 WebServiceWorkerCache_h
#define WebServiceWorkerCache_h
#include "public/platform/WebCallbacks.h"
#include "public/platform/WebCommon.h"
#include "public/platform/WebString.h"
#include "public/platform/WebVector.h"
#include "public/platform/modules/serviceworker/WebServiceWorkerCacheError.h"
#include "public/platform/modules/serviceworker/WebServiceWorkerRequest.h"
#include "public/platform/modules/serviceworker/WebServiceWorkerResponse.h"
namespace blink {
// The Service Worker Cache API. The embedder provides the implementation of the Cache to Blink. Blink uses the interface
// to operate on entries.
// This object is owned by Blink, and should be destroyed as each Cache instance is no longer in use.
class WebServiceWorkerCache {
using CacheMatchCallbacks = WebCallbacks<const WebServiceWorkerResponse&, WebServiceWorkerCacheError>;
using CacheWithResponsesCallbacks = WebCallbacks<const WebVector<WebServiceWorkerResponse>&, WebServiceWorkerCacheError>;
using CacheWithRequestsCallbacks = WebCallbacks<const WebVector<WebServiceWorkerRequest>&, WebServiceWorkerCacheError>;
using CacheBatchCallbacks = WebCallbacks<void, WebServiceWorkerCacheError>;
virtual ~WebServiceWorkerCache() { }
// Options that affect the scope of searches.
struct QueryParams {
QueryParams() : ignoreSearch(false), ignoreMethod(false), ignoreVary(false) { }
bool ignoreSearch;
bool ignoreMethod;
bool ignoreVary;
WebString cacheName;
enum OperationType {
OperationTypeLast = OperationTypeDelete
struct BatchOperation {
BatchOperation() : operationType(OperationTypeUndefined) { }
OperationType operationType;
WebServiceWorkerRequest request;
WebServiceWorkerResponse response;
QueryParams matchParams;
WebServiceWorkerCache() { }
// Ownership of the Cache*Callbacks methods passes to the WebServiceWorkerCache instance, which will delete it after
// calling onSuccess or onFailure.
virtual void dispatchMatch(CacheMatchCallbacks*, const WebServiceWorkerRequest&, const QueryParams&) = 0;
virtual void dispatchMatchAll(CacheWithResponsesCallbacks*, const WebServiceWorkerRequest&, const QueryParams&) = 0;
virtual void dispatchKeys(CacheWithRequestsCallbacks*, const WebServiceWorkerRequest&, const QueryParams&) = 0;
virtual void dispatchBatch(CacheBatchCallbacks*, const WebVector<BatchOperation>&) = 0;
} // namespace blink
#endif // WebServiceWorkerCache_h