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