WebCore:
[WebKit-https.git] / 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 "WorkerContextProxy.h"
34 #include "WorkerObjectProxy.h"
35 #include <wtf/Noncopyable.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42     class ScriptExecutionContext;
43     class String;
44     class Worker;
45     class WorkerThread;
46
47     class WorkerMessagingProxy : public WorkerContextProxy, public WorkerObjectProxy, Noncopyable {
48     public:
49         WorkerMessagingProxy(Worker*);
50
51         // Implementations of WorkerContextProxy.
52         // (Only use these methods in the worker object thread.)
53         virtual void startWorkerContext(const KURL& scriptURL, const String& userAgent, const String& sourceCode);
54         virtual void terminateWorkerContext();
55         virtual void postMessageToWorkerContext(const String& message);
56         virtual bool hasPendingActivity() const;
57         virtual void workerObjectDestroyed();
58
59         // Implementations of WorkerObjectProxy.
60         // (Only use these methods in the worker context thread.)
61         virtual void postMessageToWorkerObject(const String& message);
62         virtual void postExceptionToWorkerObject(const String& errorMessage, int lineNumber, const String& sourceURL);
63         virtual void postConsoleMessageToWorkerObject(MessageDestination, MessageSource, MessageLevel, const String& message, int lineNumber, const String& sourceURL);
64         virtual void confirmMessageFromWorkerObject(bool hasPendingActivity);
65         virtual void reportPendingActivity(bool hasPendingActivity);
66         virtual void workerContextDestroyed();
67
68         void postTaskToWorkerObject(PassRefPtr<ScriptExecutionContext::Task>);
69         void postTaskToWorkerContext(PassRefPtr<ScriptExecutionContext::Task>);
70         void postTaskForModeToWorkerContext(PassRefPtr<ScriptExecutionContext::Task>, const String& mode);
71
72         void workerThreadCreated(PassRefPtr<WorkerThread>);
73
74         // Only use this method on the worker object thread.
75         bool askedToTerminate() const { return m_askedToTerminate; }
76
77     private:
78         friend class MessageWorkerTask;
79         friend class WorkerContextDestroyedTask;
80         friend class WorkerThreadActivityReportTask;
81
82         virtual ~WorkerMessagingProxy();
83
84         void workerContextDestroyedInternal();
85         void reportPendingActivityInternal(bool confirmingMessage, bool hasPendingActivity);
86         Worker* workerObject() const { return m_workerObject; }
87
88         RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
89         Worker* m_workerObject;
90         RefPtr<WorkerThread> m_workerThread;
91
92         unsigned m_unconfirmedMessageCount; // Unconfirmed messages from worker object to worker thread.
93         bool m_workerThreadHadPendingActivity; // The latest confirmation from worker thread reported that it was still active.
94
95         bool m_askedToTerminate;
96
97         Vector<RefPtr<ScriptExecutionContext::Task> > m_queuedEarlyTasks; // Tasks are queued here until there's a thread object created.
98     };
99
100 } // namespace WebCore
101
102 #endif // ENABLE(WORKERS)
103
104 #endif // WorkerMessagingProxy_h