src/third_party/WebKit/Source/core/workers/WorkerMessagingProxy.h

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  */
  26
  27 #ifndef WorkerMessagingProxy_h
  28 #define WorkerMessagingProxy_h
  29
  30 #include "core/dom/ExecutionContext.h"
  31 #include "core/workers/WorkerGlobalScopeProxy.h"
  32 #include "core/workers/WorkerLoaderProxy.h"
  33 #include "wtf/Forward.h"
  34 #include "wtf/Noncopyable.h"
  35 #include "wtf/PassOwnPtr.h"
  36 #include "wtf/PassRefPtr.h"
  37 #include "wtf/RefPtr.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace blink {
  41
  42 class WorkerObjectProxy;
  43 class DedicatedWorkerThread;
  44 class ExecutionContext;
  45 class Worker;
  46 class WorkerClients;
  47 class WorkerInspectorProxy;
  48
  49 class WorkerMessagingProxy final : public WorkerGlobalScopeProxy, public WorkerLoaderProxy {
  50     WTF_MAKE_NONCOPYABLE(WorkerMessagingProxy); WTF_MAKE_FAST_ALLOCATED;
  51 public:
  52     WorkerMessagingProxy(Worker*, PassOwnPtrWillBeRawPtr<WorkerClients>);
  53
  54     // Implementations of WorkerGlobalScopeProxy.
  55     // (Only use these methods in the worker object thread.)
  56     virtual void startWorkerGlobalScope(const KURL& scriptURL, const String& userAgent, const String& sourceCode, WorkerThreadStartMode) override;
  57     virtual void terminateWorkerGlobalScope() override;
  58     virtual void postMessageToWorkerGlobalScope(PassRefPtr<SerializedScriptValue>, PassOwnPtr<MessagePortChannelArray>) override;
  59     virtual bool hasPendingActivity() const override;
  60     virtual void workerObjectDestroyed() override;
  61
  62     // These methods come from worker context thread via WorkerObjectProxy
  63     // and are called on the worker object thread (e.g. main thread).
  64     void postMessageToWorkerObject(PassRefPtr<SerializedScriptValue>, PassOwnPtr<MessagePortChannelArray>);
  65     void reportException(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL);
  66     void reportConsoleMessage(MessageSource, MessageLevel, const String& message, int lineNumber, const String& sourceURL);
  67     void postMessageToPageInspector(const String&);
  68     WorkerInspectorProxy* workerInspectorProxy();
  69     void confirmMessageFromWorkerObject(bool hasPendingActivity);
  70     void reportPendingActivity(bool hasPendingActivity);
  71     void workerGlobalScopeClosed();
  72     void workerThreadTerminated();
  73
  74     // Implementation of WorkerLoaderProxy.
  75     // These methods are called on different threads to schedule loading
  76     // requests and to send callbacks back to WorkerGlobalScope.
  77     virtual void postTaskToLoader(PassOwnPtr<ExecutionContextTask>) override;
  78     virtual bool postTaskToWorkerGlobalScope(PassOwnPtr<ExecutionContextTask>) override;
  79
  80     void workerThreadCreated(PassRefPtr<DedicatedWorkerThread>);
  81
  82 protected:
  83     virtual ~WorkerMessagingProxy();
  84
  85 private:
  86     static void workerObjectDestroyedInternal(ExecutionContext*, WorkerMessagingProxy*);
  87     void terminateInternally();
  88
  89     RefPtrWillBePersistent<ExecutionContext> m_executionContext;
  90     OwnPtr<WorkerObjectProxy> m_workerObjectProxy;
  91     Worker* m_workerObject;
  92     bool m_mayBeDestroyed;
  93     RefPtr<DedicatedWorkerThread> m_workerThread;
  94
  95     unsigned m_unconfirmedMessageCount; // Unconfirmed messages from worker object to worker thread.
  96     bool m_workerThreadHadPendingActivity; // The latest confirmation from worker thread reported that it was still active.
  97
  98     bool m_askedToTerminate;
  99
 100     Vector<OwnPtr<ExecutionContextTask>> m_queuedEarlyTasks; // Tasks are queued here until there's a thread object created.
 101     OwnPtr<WorkerInspectorProxy> m_workerInspectorProxy;
 102
 103     OwnPtrWillBePersistent<WorkerClients> m_workerClients;
 104 };
 105
 106 } // namespace blink
 107
 108 #endif // WorkerMessagingProxy_h