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/ServiceWorker.h"
  39 #include "platform/heap/Handle.h"
  40 #include "public/platform/WebServiceWorkerProviderClient.h"
  41 #include "wtf/Forward.h"
  42 #include "wtf/PassRefPtr.h"
  43 #include "wtf/RefCounted.h"
  44 #include "wtf/RefPtr.h"
  45
  46 namespace blink {
  47
  48 class Dictionary;
  49 class ExecutionContext;
  50 class ServiceWorker;
  51 class WebServiceWorkerProvider;
  52 class WebServiceWorker;
  53
  54 class ServiceWorkerContainer FINAL
  55     : public RefCountedWillBeGarbageCollectedFinalized<ServiceWorkerContainer>
  56     , public ScriptWrappable
  57     , public ContextLifecycleObserver
  58     , public WebServiceWorkerProviderClient {
  59 public:
  60     static PassRefPtrWillBeRawPtr<ServiceWorkerContainer> create(ExecutionContext*);
  61     ~ServiceWorkerContainer();
  62
  63     void willBeDetachedFromFrame();
  64
  65     void trace(Visitor*);
  66
  67     PassRefPtrWillBeRawPtr<ServiceWorker> active() { return m_active.get(); }
  68     PassRefPtrWillBeRawPtr<ServiceWorker> controller() { return m_controller.get(); }
  69     PassRefPtrWillBeRawPtr<ServiceWorker> installing() { return m_installing.get(); }
  70     PassRefPtrWillBeRawPtr<ServiceWorker> waiting() { return m_waiting.get(); }
  71     ScriptPromise ready(ScriptState*);
  72     WebServiceWorkerProvider* provider() { return m_provider; }
  73
  74     ScriptPromise registerServiceWorker(ScriptState*, const String& pattern, const Dictionary&);
  75     ScriptPromise unregisterServiceWorker(ScriptState*, const String& scope);
  76
  77     // WebServiceWorkerProviderClient overrides.
  78     virtual void setActive(WebServiceWorker*) OVERRIDE;
  79     virtual void setController(WebServiceWorker*) OVERRIDE;
  80     virtual void setInstalling(WebServiceWorker*) OVERRIDE;
  81     virtual void setWaiting(WebServiceWorker*) OVERRIDE;
  82     virtual void dispatchMessageEvent(const WebString& message, const WebMessagePortChannelArray&) OVERRIDE;
  83
  84 private:
  85     explicit ServiceWorkerContainer(ExecutionContext*);
  86
  87     typedef ScriptPromiseProperty<RawPtrWillBeMember<ServiceWorkerContainer>, RefPtrWillBeMember<ServiceWorker>, RefPtrWillBeMember<ServiceWorker> > ReadyProperty;
  88     ReadyProperty* createReadyProperty();
  89     void checkReadyChanged(PassRefPtrWillBeRawPtr<ServiceWorker> previousReadyWorker);
  90
  91     WebServiceWorkerProvider* m_provider;
  92     RefPtrWillBeMember<ServiceWorker> m_active;
  93     RefPtrWillBeMember<ServiceWorker> m_controller;
  94     RefPtrWillBeMember<ServiceWorker> m_installing;
  95     RefPtrWillBeMember<ServiceWorker> m_waiting;
  96     PersistentWillBeMember<ReadyProperty> m_ready;
  97 };
  98
  99 } // namespace blink
 100
 101 #endif // ServiceWorkerContainer_h