Manage MessagePort, MessagePortChannel and friends through std::unique_ptr
[WebKit-https.git] / Source / WebCore / 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 "ScriptExecutionContext.h"
31 #include "WorkerGlobalScopeProxy.h"
32 #include "WorkerLoaderProxy.h"
33 #include "WorkerObjectProxy.h"
34 #include <memory>
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41
42 namespace WebCore {
43
44     class DedicatedWorkerThread;
45     class ScriptExecutionContext;
46     class Worker;
47
48     class WorkerMessagingProxy : public WorkerGlobalScopeProxy, public WorkerObjectProxy, public WorkerLoaderProxy {
49         WTF_MAKE_NONCOPYABLE(WorkerMessagingProxy); WTF_MAKE_FAST_ALLOCATED;
50     public:
51         explicit WorkerMessagingProxy(Worker*);
52
53         // Implementations of WorkerGlobalScopeProxy.
54         // (Only use these methods in the worker object thread.)
55         virtual void startWorkerGlobalScope(const URL& scriptURL, const String& userAgent, const String& sourceCode, WorkerThreadStartMode) override;
56         virtual void terminateWorkerGlobalScope() override;
57         virtual void postMessageToWorkerGlobalScope(PassRefPtr<SerializedScriptValue>, std::unique_ptr<MessagePortChannelArray>) override;
58         virtual bool hasPendingActivity() const override;
59         virtual void workerObjectDestroyed() override;
60         virtual void notifyNetworkStateChange(bool isOnline) override;
61 #if ENABLE(INSPECTOR)
62         virtual void connectToInspector(WorkerGlobalScopeProxy::PageInspector*) override;
63         virtual void disconnectFromInspector() override;
64         virtual void sendMessageToInspector(const String&) override;
65 #endif
66
67         // Implementations of WorkerObjectProxy.
68         // (Only use these methods in the worker context thread.)
69         virtual void postMessageToWorkerObject(PassRefPtr<SerializedScriptValue>, std::unique_ptr<MessagePortChannelArray>) override;
70         virtual void postExceptionToWorkerObject(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL) override;
71         virtual void postConsoleMessageToWorkerObject(MessageSource, MessageLevel, const String& message, int lineNumber, int columnNumber, const String& sourceURL) override;
72 #if ENABLE(INSPECTOR)
73         virtual void postMessageToPageInspector(const String&) override;
74 #endif
75         virtual void confirmMessageFromWorkerObject(bool hasPendingActivity) override;
76         virtual void reportPendingActivity(bool hasPendingActivity) override;
77         virtual void workerGlobalScopeClosed() override;
78         virtual void workerGlobalScopeDestroyed() override;
79
80         // Implementation of WorkerLoaderProxy.
81         // These methods are called on different threads to schedule loading
82         // requests and to send callbacks back to WorkerGlobalScope.
83         virtual void postTaskToLoader(PassOwnPtr<ScriptExecutionContext::Task>) override;
84         virtual bool postTaskForModeToWorkerGlobalScope(PassOwnPtr<ScriptExecutionContext::Task>, const String& mode) override;
85
86         void workerThreadCreated(PassRefPtr<DedicatedWorkerThread>);
87
88         // Only use this method on the worker object thread.
89         bool askedToTerminate() const { return m_askedToTerminate; }
90
91     protected:
92         virtual ~WorkerMessagingProxy();
93
94     private:
95         friend class MessageWorkerTask;
96         friend class PostMessageToPageInspectorTask;
97         friend class WorkerGlobalScopeDestroyedTask;
98         friend class WorkerExceptionTask;
99         friend class WorkerThreadActivityReportTask;
100
101         void workerGlobalScopeDestroyedInternal();
102         static void workerObjectDestroyedInternal(ScriptExecutionContext*, WorkerMessagingProxy*);
103         void reportPendingActivityInternal(bool confirmingMessage, bool hasPendingActivity);
104         Worker* workerObject() const { return m_workerObject; }
105
106         RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
107         Worker* m_workerObject;
108         bool m_mayBeDestroyed;
109         RefPtr<DedicatedWorkerThread> m_workerThread;
110
111         unsigned m_unconfirmedMessageCount; // Unconfirmed messages from worker object to worker thread.
112         bool m_workerThreadHadPendingActivity; // The latest confirmation from worker thread reported that it was still active.
113
114         bool m_askedToTerminate;
115
116         Vector<OwnPtr<ScriptExecutionContext::Task>> m_queuedEarlyTasks; // Tasks are queued here until there's a thread object created.
117 #if ENABLE(INSPECTOR)
118         WorkerGlobalScopeProxy::PageInspector* m_pageInspector;
119 #endif
120     };
121
122 } // namespace WebCore
123
124 #endif // WorkerMessagingProxy_h