Remove unused parameters from WTF threading API
[WebKit-https.git] / Source / WebCore / workers / WorkerThread.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 WorkerThread_h
28 #define WorkerThread_h
29
30 #if ENABLE(WORKERS)
31
32 #include "ContentSecurityPolicy.h"
33 #include "WorkerRunLoop.h"
34 #include <wtf/Forward.h>
35 #include <wtf/OwnPtr.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38
39 namespace WebCore {
40
41     class KURL;
42     class NotificationPresenter;
43     class WorkerContext;
44     class WorkerLoaderProxy;
45     class WorkerReportingProxy;
46     struct WorkerThreadStartupData;
47
48     enum WorkerThreadStartMode { DontPauseWorkerContextOnStart, PauseWorkerContextOnStart };
49
50     class WorkerThread : public RefCounted<WorkerThread> {
51     public:
52         virtual ~WorkerThread();
53
54         bool start();
55         void stop();
56
57         ThreadIdentifier threadID() const { return m_threadID; }
58         WorkerRunLoop& runLoop() { return m_runLoop; }
59         WorkerLoaderProxy& workerLoaderProxy() const { return m_workerLoaderProxy; }
60         WorkerReportingProxy& workerReportingProxy() const { return m_workerReportingProxy; }
61
62         // Number of active worker threads.
63         static unsigned workerThreadCount();
64
65 #if ENABLE(NOTIFICATIONS)
66         NotificationPresenter* getNotificationPresenter() { return m_notificationPresenter; }
67         void setNotificationPresenter(NotificationPresenter* presenter) { m_notificationPresenter = presenter; }
68 #endif
69
70     protected:
71         WorkerThread(const KURL&, const String& userAgent, const String& sourceCode, WorkerLoaderProxy&, WorkerReportingProxy&, WorkerThreadStartMode, const String& contentSecurityPolicy, ContentSecurityPolicy::HeaderType);
72
73         // Factory method for creating a new worker context for the thread.
74         virtual PassRefPtr<WorkerContext> createWorkerContext(const KURL&, const String& userAgent, const String& contentSecurityPolicy, ContentSecurityPolicy::HeaderType) = 0;
75
76         // Executes the event loop for the worker thread. Derived classes can override to perform actions before/after entering the event loop.
77         virtual void runEventLoop();
78
79         WorkerContext* workerContext() { return m_workerContext.get(); }
80
81     private:
82         // Static function executed as the core routine on the new thread. Passed a pointer to a WorkerThread object.
83         static void workerThreadStart(void*);
84         void workerThread();
85
86         ThreadIdentifier m_threadID;
87         WorkerRunLoop m_runLoop;
88         WorkerLoaderProxy& m_workerLoaderProxy;
89         WorkerReportingProxy& m_workerReportingProxy;
90
91         RefPtr<WorkerContext> m_workerContext;
92         Mutex m_threadCreationMutex;
93
94         OwnPtr<WorkerThreadStartupData> m_startupData;
95
96 #if ENABLE(NOTIFICATIONS)
97         NotificationPresenter* m_notificationPresenter;
98 #endif
99
100         // Track the number of WorkerThread instances for use in layout tests.
101         static unsigned m_threadCount;
102     };
103
104 } // namespace WebCore
105
106 #endif // ENABLE(WORKERS)
107
108 #endif // WorkerThread_h
109