src/third_party/WebKit/public/platform/WebServiceWorkerProvider.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebServiceWorkerProvider_h
  32 #define WebServiceWorkerProvider_h
  33
  34 #include "public/platform/WebCallbacks.h"
  35
  36 namespace blink {
  37
  38 class WebString;
  39 class WebURL;
  40 class WebServiceWorker;
  41 class WebServiceWorkerProviderClient;
  42 class WebServiceWorkerRegistration;
  43 struct WebServiceWorkerError;
  44
  45 // Created on the main thread, and may be passed to another script context
  46 // thread (e.g. worker thread) later. All methods of this class must be called
  47 // on the single script context thread.
  48 class WebServiceWorkerProvider {
  49 public:
  50     // Called when a client wants to start listening to the service worker
  51     // events. Must be cleared before the client becomes invalid.
  52     virtual void setClient(WebServiceWorkerProviderClient*) { }
  53
  54     // The WebServiceWorkerRegistration and WebServiceWorkerError ownership are
  55     // passed to the WebServiceWorkerRegistrationCallbacks implementation.
  56     typedef WebCallbacks<WebServiceWorkerRegistration, WebServiceWorkerError> WebServiceWorkerRegistrationCallbacks;
  57
  58     virtual void registerServiceWorker(const WebURL& pattern, const WebURL& scriptUrl, WebServiceWorkerRegistrationCallbacks*) { }
  59
  60     // Unregisters the ServiceWorker for a given scope. The provider
  61     // must always pass null to onSuccess.
  62     // FIXME: "unregister" does not provide a WebServiceWorkerRegistration,
  63     // revisit this to clean up the the callback type to not take a
  64     // WebServiceWorkerRegistration*.
  65     virtual void unregisterServiceWorker(const WebURL& pattern, WebServiceWorkerRegistrationCallbacks*) { }
  66
  67     virtual ~WebServiceWorkerProvider() { }
  68 };
  69
  70 } // namespace blink
  71
  72 #endif