src/third_party/WebKit/Source/web/WebEmbeddedWorkerImpl.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 WebEmbeddedWorkerImpl_h
  32 #define WebEmbeddedWorkerImpl_h
  33
  34 #include "public/web/WebContentSecurityPolicy.h"
  35 #include "public/web/WebEmbeddedWorker.h"
  36 #include "public/web/WebEmbeddedWorkerStartData.h"
  37 #include "public/web/WebFrameClient.h"
  38
  39 namespace blink {
  40
  41 class ServiceWorkerGlobalScopeProxy;
  42 class WebServiceWorkerNetworkProvider;
  43 class WebView;
  44 class WorkerScriptLoader;
  45 class WorkerThread;
  46
  47 class WebEmbeddedWorkerImpl FINAL
  48     : public WebEmbeddedWorker
  49     , public WebFrameClient {
  50     WTF_MAKE_NONCOPYABLE(WebEmbeddedWorkerImpl);
  51 public:
  52     WebEmbeddedWorkerImpl(
  53         PassOwnPtr<WebServiceWorkerContextClient>,
  54         PassOwnPtr<WebWorkerPermissionClientProxy>);
  55     virtual ~WebEmbeddedWorkerImpl();
  56
  57     // Terminate all WebEmbeddedWorkerImpl for testing purposes.
  58     // Note that this only schedules termination and
  59     // does not synchronously wait for it to complete.
  60     static void terminateAll();
  61
  62     // WebEmbeddedWorker overrides.
  63     virtual void startWorkerContext(const WebEmbeddedWorkerStartData&) OVERRIDE;
  64     virtual void resumeAfterDownload() OVERRIDE;
  65     virtual void terminateWorkerContext() OVERRIDE;
  66     virtual void resumeWorkerContext() OVERRIDE;
  67     virtual void attachDevTools() OVERRIDE;
  68     virtual void reattachDevTools(const WebString& savedState) OVERRIDE;
  69     virtual void detachDevTools() OVERRIDE;
  70     virtual void dispatchDevToolsMessage(const WebString&) OVERRIDE;
  71
  72 private:
  73     class Loader;
  74     class LoaderProxy;
  75
  76     void prepareShadowPageForLoader();
  77
  78     // WebFrameClient overrides.
  79     virtual void willSendRequest(
  80         WebLocalFrame*, unsigned identifier, WebURLRequest&,
  81         const WebURLResponse& redirectResponse) OVERRIDE;
  82     virtual void didFinishDocumentLoad(WebLocalFrame*) OVERRIDE;
  83
  84     void onScriptLoaderFinished();
  85     void startWorkerThread();
  86
  87     WebEmbeddedWorkerStartData m_workerStartData;
  88
  89     OwnPtr<WebServiceWorkerContextClient> m_workerContextClient;
  90
  91     // This is kept until startWorkerContext is called, and then passed on
  92     // to WorkerContext.
  93     OwnPtr<WebWorkerPermissionClientProxy> m_permissionClient;
  94
  95     // We retain ownership of this one which is for use on the
  96     // main thread only.
  97     OwnPtr<WebServiceWorkerNetworkProvider> m_networkProvider;
  98
  99     // Kept around only while main script loading is ongoing.
 100     OwnPtr<Loader> m_mainScriptLoader;
 101
 102     RefPtr<WorkerThread> m_workerThread;
 103     OwnPtr<LoaderProxy> m_loaderProxy;
 104     OwnPtr<ServiceWorkerGlobalScopeProxy> m_workerGlobalScopeProxy;
 105
 106     // 'shadow page' - created to proxy loading requests from the worker.
 107     // Both WebView and WebFrame objects are close()'ed (where they're
 108     // deref'ed) when this EmbeddedWorkerImpl is destructed, therefore they
 109     // are guaranteed to exist while this object is around.
 110     WebView* m_webView;
 111     WebFrame* m_mainFrame;
 112
 113     bool m_askedToTerminate;
 114
 115     enum {
 116         DontPauseAfterDownload,
 117         DoPauseAfterDownload,
 118         IsPausedAfterDownload
 119     } m_pauseAfterDownloadState;
 120 };
 121
 122 } // namespace blink
 123
 124 #endif // WebEmbeddedWorkerImpl_h