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