third_party/WebKit/public/platform/modules/serviceworker/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 #include "public/platform/WebPassOwnPtr.h"
  36 #include "public/platform/WebServiceWorkerRegistration.h"
  37 #include "public/platform/WebVector.h"
  38
  39 namespace blink {
  40
  41 class WebURL;
  42 class WebServiceWorker;
  43 class WebServiceWorkerProviderClient;
  44 struct WebServiceWorkerError;
  45
  46 // Created on the main thread, and may be passed to another script context
  47 // thread (e.g. worker thread) later. All methods of this class must be called
  48 // on the single script context thread.
  49 class WebServiceWorkerProvider {
  50 public:
  51     // Called when a client wants to start listening to the service worker
  52     // events. Must be cleared before the client becomes invalid.
  53     virtual void setClient(WebServiceWorkerProviderClient*) { }
  54
  55     using WebServiceWorkerRegistrationCallbacks = WebCallbacks<WebPassOwnPtr<WebServiceWorkerRegistration::Handle>, const WebServiceWorkerError&>;
  56     using WebServiceWorkerGetRegistrationCallbacks = WebCallbacks<WebPassOwnPtr<WebServiceWorkerRegistration::Handle>, const WebServiceWorkerError&>;
  57
  58     // Each element's ownership is transferred.
  59     // TODO(yhirano): Consider using vector<scoped_ptr<>>.
  60     using WebServiceWorkerGetRegistrationsCallbacks = WebCallbacks<WebPassOwnPtr<WebVector<WebServiceWorkerRegistration::Handle*>>, const WebServiceWorkerError&>;
  61     using WebServiceWorkerGetRegistrationForReadyCallbacks = WebCallbacks<WebPassOwnPtr<WebServiceWorkerRegistration::Handle>, void>;
  62
  63     virtual void registerServiceWorker(const WebURL& pattern, const WebURL& scriptUrl, WebServiceWorkerRegistrationCallbacks*) { }
  64     virtual void getRegistration(const WebURL& documentURL, WebServiceWorkerGetRegistrationCallbacks*) { }
  65     virtual void getRegistrations(WebServiceWorkerGetRegistrationsCallbacks*) { }
  66     virtual void getRegistrationForReady(WebServiceWorkerGetRegistrationForReadyCallbacks*) { }
  67     virtual bool validateScopeAndScriptURL(const WebURL& scope, const WebURL& scriptURL, WebString* errorMessage) { return false; }
  68
  69     virtual ~WebServiceWorkerProvider() { }
  70 };
  71
  72 } // namespace blink
  73
  74 #endif