src/third_party/WebKit/Source/core/loader/WorkerThreadableLoader.h

   1 /*
   2  * Copyright (C) 2009 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 WorkerThreadableLoader_h
  32 #define WorkerThreadableLoader_h
  33
  34 #include "core/loader/ThreadableLoader.h"
  35 #include "core/loader/ThreadableLoaderClient.h"
  36 #include "core/loader/ThreadableLoaderClientWrapper.h"
  37 #include "platform/heap/Handle.h"
  38 #include "wtf/PassOwnPtr.h"
  39 #include "wtf/PassRefPtr.h"
  40 #include "wtf/RefPtr.h"
  41 #include "wtf/Threading.h"
  42 #include "wtf/text/WTFString.h"
  43
  44 namespace blink {
  45
  46     class ResourceError;
  47     class ResourceRequest;
  48     class WorkerGlobalScope;
  49     class WorkerLoaderProxy;
  50     struct CrossThreadResourceResponseData;
  51     struct CrossThreadResourceRequestData;
  52
  53     class WorkerThreadableLoader FINAL : public ThreadableLoader {
  54         WTF_MAKE_FAST_ALLOCATED;
  55     public:
  56         static void loadResourceSynchronously(WorkerGlobalScope&, const ResourceRequest&, ThreadableLoaderClient&, const ThreadableLoaderOptions&, const ResourceLoaderOptions&);
  57         static PassRefPtr<WorkerThreadableLoader> create(WorkerGlobalScope& workerGlobalScope, PassRefPtr<ThreadableLoaderClientWrapper> clientWrapper, PassOwnPtr<ThreadableLoaderClient> clientBridge, const ResourceRequest& request, const ThreadableLoaderOptions& options, const ResourceLoaderOptions& resourceLoaderOptions)
  58         {
  59             return adoptRef(new WorkerThreadableLoader(workerGlobalScope, clientWrapper, clientBridge, request, options, resourceLoaderOptions));
  60         }
  61
  62         virtual ~WorkerThreadableLoader();
  63
  64         virtual void overrideTimeout(unsigned long timeout) OVERRIDE;
  65
  66         virtual void cancel() OVERRIDE;
  67
  68     private:
  69         // Creates a loader on the main thread and bridges communication between
  70         // the main thread and the worker context's thread where WorkerThreadableLoader runs.
  71         //
  72         // Regarding the bridge and lifetimes of items used in callbacks, there are a few cases:
  73         //
  74         // all cases. All tasks posted from the worker context's thread are ok because
  75         //    the last task posted always is "mainThreadDestroy", so MainThreadBridge is
  76         //    around for all tasks that use it on the main thread.
  77         //
  78         // case 1. worker.terminate is called.
  79         //    In this case, no more tasks are posted from the worker object's thread to the worker
  80         //    context's thread -- WorkerGlobalScopeProxy implementation enforces this.
  81         //
  82         // case 2. xhr gets aborted and the worker context continues running.
  83         //    The ThreadableLoaderClientWrapper has the underlying client cleared, so no more calls
  84         //    go through it.  All tasks posted from the worker object's thread to the worker context's
  85         //    thread do "ThreadableLoaderClientWrapper::ref" (automatically inside of the cross thread copy
  86         //    done in createCrossThreadTask), so the ThreadableLoaderClientWrapper instance is there until all
  87         //    tasks are executed.
  88         class MainThreadBridge FINAL : public ThreadableLoaderClient {
  89         public:
  90             // All executed on the worker context's thread.
  91             MainThreadBridge(PassRefPtr<ThreadableLoaderClientWrapper>, PassOwnPtr<ThreadableLoaderClient>, WorkerLoaderProxy&, const ResourceRequest&, const ThreadableLoaderOptions&, const ResourceLoaderOptions&, const String& outgoingReferrer);
  92             void overrideTimeout(unsigned long timeoutMilliseconds);
  93             void cancel();
  94             void destroy();
  95
  96         private:
  97             // Executed on the worker context's thread.
  98             void clearClientWrapper();
  99
 100             // All executed on the main thread.
 101             static void mainThreadDestroy(ExecutionContext*, MainThreadBridge*);
 102             virtual ~MainThreadBridge();
 103
 104             static void mainThreadCreateLoader(ExecutionContext*, MainThreadBridge*, PassOwnPtr<CrossThreadResourceRequestData>, ThreadableLoaderOptions, ResourceLoaderOptions, const String& outgoingReferrer);
 105             static void mainThreadOverrideTimeout(ExecutionContext*, MainThreadBridge*, unsigned long timeoutMilliseconds);
 106             static void mainThreadCancel(ExecutionContext*, MainThreadBridge*);
 107             virtual void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent) OVERRIDE;
 108             virtual void didReceiveResponse(unsigned long identifier, const ResourceResponse&) OVERRIDE;
 109             virtual void didReceiveData(const char*, int dataLength) OVERRIDE;
 110             virtual void didDownloadData(int dataLength) OVERRIDE;
 111             virtual void didReceiveCachedMetadata(const char*, int dataLength) OVERRIDE;
 112             virtual void didFinishLoading(unsigned long identifier, double finishTime) OVERRIDE;
 113             virtual void didFail(const ResourceError&) OVERRIDE;
 114             virtual void didFailAccessControlCheck(const ResourceError&) OVERRIDE;
 115             virtual void didFailRedirectCheck() OVERRIDE;
 116
 117             // Only to be used on the main thread.
 118             RefPtr<ThreadableLoader> m_mainThreadLoader;
 119             OwnPtr<ThreadableLoaderClient> m_clientBridge;
 120
 121             // ThreadableLoaderClientWrapper is to be used on the worker context thread.
 122             // The ref counting is done on either thread.
 123             RefPtr<ThreadableLoaderClientWrapper> m_workerClientWrapper;
 124
 125             // Used on the worker context thread.
 126             WorkerLoaderProxy& m_loaderProxy;
 127         };
 128
 129         WorkerThreadableLoader(WorkerGlobalScope&, PassRefPtr<ThreadableLoaderClientWrapper>, PassOwnPtr<ThreadableLoaderClient>, const ResourceRequest&, const ThreadableLoaderOptions&, const ResourceLoaderOptions&);
 130
 131         RefPtrWillBePersistent<WorkerGlobalScope> m_workerGlobalScope;
 132         RefPtr<ThreadableLoaderClientWrapper> m_workerClientWrapper;
 133         MainThreadBridge& m_bridge;
 134     };
 135
 136 } // namespace blink
 137
 138 #endif // WorkerThreadableLoader_h