src/third_party/WebKit/Source/modules/serviceworkers/ServiceWorkerGlobalScopeClient.h

   1 /*
   2  * Copyright (C) 2014 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 ServiceWorkerGlobalScopeClient_h
  32 #define ServiceWorkerGlobalScopeClient_h
  33
  34 #include "core/dom/MessagePort.h"
  35 #include "core/workers/WorkerClients.h"
  36 #include "public/platform/WebCallbacks.h"
  37 #include "public/platform/WebMessagePortChannel.h"
  38 #include "public/platform/WebServiceWorkerClientsInfo.h"
  39 #include "public/platform/WebServiceWorkerEventResult.h"
  40 #include "wtf/Forward.h"
  41 #include "wtf/Noncopyable.h"
  42
  43 namespace blink {
  44
  45 class ExecutionContext;
  46 class Response;
  47 class WebServiceWorkerCacheStorage;
  48 class WebURL;
  49 class WorkerClients;
  50
  51 class ServiceWorkerGlobalScopeClient : public WillBeHeapSupplement<WorkerClients> {
  52     WTF_MAKE_NONCOPYABLE(ServiceWorkerGlobalScopeClient);
  53 public:
  54     virtual ~ServiceWorkerGlobalScopeClient() { }
  55
  56     virtual void getClients(WebServiceWorkerClientsCallbacks*) = 0;
  57     virtual WebURL scope() const = 0;
  58     virtual WebServiceWorkerCacheStorage* cacheStorage() const = 0;
  59
  60     virtual void didHandleActivateEvent(int eventID, WebServiceWorkerEventResult) = 0;
  61     virtual void didHandleInstallEvent(int installEventID, WebServiceWorkerEventResult) = 0;
  62     // A null response means no valid response was provided by the service worker, so fallback to native.
  63     virtual void didHandleFetchEvent(int fetchEventID, PassRefPtrWillBeRawPtr<Response> = nullptr) = 0;
  64     virtual void didHandleSyncEvent(int syncEventID) = 0;
  65     virtual void postMessageToClient(int clientID, const WebString& message, PassOwnPtr<WebMessagePortChannelArray>) = 0;
  66
  67     static const char* supplementName();
  68     static ServiceWorkerGlobalScopeClient* from(ExecutionContext*);
  69
  70 protected:
  71     ServiceWorkerGlobalScopeClient() { }
  72 };
  73
  74 void provideServiceWorkerGlobalScopeClientToWorker(WorkerClients*, PassOwnPtrWillBeRawPtr<ServiceWorkerGlobalScopeClient>);
  75
  76 } // namespace blink
  77
  78 #endif // ServiceWorkerGlobalScopeClient_h