src/third_party/WebKit/Source/modules/serviceworkers/ServiceWorkerContainer.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 ServiceWorkerContainer_h
  32 #define ServiceWorkerContainer_h
  33
  34 #include "bindings/core/v8/ScriptPromise.h"
  35 #include "bindings/core/v8/ScriptPromiseProperty.h"
  36 #include "bindings/core/v8/ScriptWrappable.h"
  37 #include "core/dom/ContextLifecycleObserver.h"
  38 #include "modules/serviceworkers/RegistrationOptions.h"
  39 #include "modules/serviceworkers/ServiceWorker.h"
  40 #include "modules/serviceworkers/ServiceWorkerRegistration.h"
  41 #include "platform/heap/Handle.h"
  42 #include "public/platform/WebServiceWorkerProviderClient.h"
  43 #include "wtf/Forward.h"
  44 #include "wtf/PassRefPtr.h"
  45 #include "wtf/RefPtr.h"
  46
  47 namespace blink {
  48
  49 class ExecutionContext;
  50 class WebServiceWorker;
  51 class WebServiceWorkerProvider;
  52 class WebServiceWorkerRegistration;
  53
  54 class ServiceWorkerContainer final
  55     : public GarbageCollectedFinalized<ServiceWorkerContainer>
  56     , public ScriptWrappable
  57     , public ContextLifecycleObserver
  58     , public WebServiceWorkerProviderClient {
  59     DEFINE_WRAPPERTYPEINFO();
  60 public:
  61     static ServiceWorkerContainer* create(ExecutionContext*);
  62     ~ServiceWorkerContainer();
  63
  64     void willBeDetachedFromFrame();
  65
  66     void trace(Visitor*);
  67
  68     PassRefPtrWillBeRawPtr<ServiceWorker> controller() { return m_controller.get(); }
  69     ScriptPromise ready(ScriptState*);
  70     WebServiceWorkerProvider* provider() { return m_provider; }
  71
  72     ScriptPromise registerServiceWorker(ScriptState*, const String& pattern, const RegistrationOptions&);
  73     ScriptPromise getRegistration(ScriptState*, const String& documentURL);
  74
  75     // WebServiceWorkerProviderClient overrides.
  76     virtual void setController(WebServiceWorker*) override;
  77     virtual void setReadyRegistration(WebServiceWorkerRegistration*) override;
  78     virtual void dispatchMessageEvent(const WebString& message, const WebMessagePortChannelArray&) override;
  79
  80 private:
  81     explicit ServiceWorkerContainer(ExecutionContext*);
  82
  83     typedef ScriptPromiseProperty<Member<ServiceWorkerContainer>, Member<ServiceWorkerRegistration>, Member<ServiceWorkerRegistration> > ReadyProperty;
  84     ReadyProperty* createReadyProperty();
  85
  86     WebServiceWorkerProvider* m_provider;
  87     RefPtrWillBeMember<ServiceWorker> m_controller;
  88     Member<ServiceWorkerRegistration> m_readyRegistration;
  89     Member<ReadyProperty> m_ready;
  90 };
  91
  92 } // namespace blink
  93
  94 #endif // ServiceWorkerContainer_h