7fdc8750ce251646955ca73e5f81164c4171ea7d
[WebKit-https.git] / WebCore / dom / 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 <wtf/Noncopyable.h>
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40     class ScriptExecutionContext;
41     class String;
42     class Worker;
43     class WorkerTask;
44     class WorkerThread;
45
46     class WorkerMessagingProxy : Noncopyable {
47     public:
48         WorkerMessagingProxy(PassRefPtr<ScriptExecutionContext>, Worker*);
49
50         void postMessageToWorkerObject(const String& message);
51         void postMessageToWorkerContext(const String& message);
52         void postTaskToParentContext(PassRefPtr<ScriptExecutionContext::Task>);
53
54         void postWorkerException(const String& errorMessage, int lineNumber, const String& sourceURL);
55
56         void workerThreadCreated(PassRefPtr<WorkerThread>);
57         void workerObjectDestroyed();
58         void workerContextDestroyed();
59
60         void confirmWorkerThreadMessage(bool hasPendingActivity);
61         void reportWorkerThreadActivity(bool hasPendingActivity);
62         bool workerThreadHasPendingActivity() const;
63
64         // Only use these methods on the worker object thread.
65         void terminate();
66         bool askedToTerminate() const { return m_askedToTerminate; }
67
68     private:
69         friend class MessageWorkerTask;
70         friend class WorkerContextDestroyedTask;
71         friend class WorkerThreadActivityReportTask;
72
73         ~WorkerMessagingProxy();
74
75         void workerContextDestroyedInternal();
76         void reportWorkerThreadActivityInternal(bool confirmingMessage, bool hasPendingActivity);
77         Worker* workerObject() const { return m_workerObject; }
78
79         RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
80         Worker* m_workerObject;
81         RefPtr<WorkerThread> m_workerThread;
82
83         unsigned m_unconfirmedMessageCount; // Unconfirmed messages from worker object to worker thread.
84         bool m_workerThreadHadPendingActivity; // The latest confirmation from worker thread reported that it was still active.
85
86         bool m_askedToTerminate;
87
88         Vector<RefPtr<WorkerTask> > m_queuedEarlyTasks; // Tasks are queued here until there's a thread object created.
89     };
90
91 } // namespace WebCore
92
93 #endif // ENABLE(WORKERS)
94
95 #endif // WorkerMessagingProxy_h