third_party/WebKit/public/web/modules/serviceworker/WebServiceWorkerContextProxy.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 WebServiceWorkerContextProxy_h
  32 #define WebServiceWorkerContextProxy_h
  33
  34 #include "public/platform/WebGeofencingEventType.h"
  35 #include "public/platform/WebMessagePortChannel.h"
  36 #include "public/platform/WebPassOwnPtr.h"
  37 #include "public/platform/modules/navigator_services/WebServicePortCallbacks.h"
  38 #include "public/platform/modules/serviceworker/WebServiceWorkerRegistration.h"
  39
  40 namespace blink {
  41
  42 struct WebCircularGeofencingRegion;
  43 struct WebCrossOriginServiceWorkerClient;
  44 struct WebNotificationData;
  45 class WebServiceWorkerRequest;
  46 class WebString;
  47 struct WebSyncRegistration;
  48
  49 // A proxy interface to talk to the worker's GlobalScope implementation.
  50 // All methods of this class must be called on the worker thread.
  51 class WebServiceWorkerContextProxy {
  52 public:
  53     virtual ~WebServiceWorkerContextProxy() { }
  54
  55     virtual void setRegistration(WebPassOwnPtr<WebServiceWorkerRegistration::Handle>) = 0;
  56
  57     virtual void dispatchActivateEvent(int eventID) = 0;
  58     // FIXME: This needs to pass the active service worker info.
  59     virtual void dispatchInstallEvent(int installEventID) = 0;
  60     virtual void dispatchFetchEvent(int fetchEventID, const WebServiceWorkerRequest& webRequest) = 0;
  61
  62     virtual void dispatchGeofencingEvent(int eventID, WebGeofencingEventType, const WebString& regionID, const WebCircularGeofencingRegion&) = 0;
  63
  64     virtual void dispatchMessageEvent(const WebString& message, const WebMessagePortChannelArray& channels) = 0;
  65
  66     virtual void dispatchNotificationClickEvent(int eventID, int64_t notificationID, const WebNotificationData&, int actionIndex) = 0;
  67
  68     virtual void dispatchPushEvent(int eventID, const WebString& data) = 0;
  69
  70     virtual void dispatchCrossOriginMessageEvent(const WebCrossOriginServiceWorkerClient&, const WebString& message, const WebMessagePortChannelArray&) = 0;
  71
  72     // Passes ownership of the callbacks.
  73     virtual void dispatchServicePortConnectEvent(WebServicePortConnectEventCallbacks*, const WebURL& targetURL, const WebString& origin, WebServicePortID) = 0;
  74
  75     // Once the ServiceWorker has finished handling the sync event,
  76     // didHandleSyncEvent is called on the context client.
  77     virtual void dispatchSyncEvent(int syncEventID, const WebSyncRegistration&) = 0;
  78 };
  79
  80 } // namespace blink
  81
  82 #endif // WebServiceWorkerContextProxy_h