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