Home | History | Annotate | Download | only in workers
      1 /*
      2  * Copyright (C) 2009 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WorkerRunLoop_h
     32 #define WorkerRunLoop_h
     33 
     34 #include "core/dom/ExecutionContext.h"
     35 #include "core/dom/ExecutionContextTask.h"
     36 #include "public/platform/WebThread.h"
     37 #include "wtf/Functional.h"
     38 #include "wtf/MessageQueue.h"
     39 #include "wtf/OwnPtr.h"
     40 #include "wtf/PassOwnPtr.h"
     41 
     42 namespace WebCore {
     43 
     44     class WorkerGlobalScope;
     45     class WorkerSharedTimer;
     46 
     47     class WorkerRunLoop {
     48     public:
     49         WorkerRunLoop();
     50         ~WorkerRunLoop();
     51 
     52         void setWorkerGlobalScope(WorkerGlobalScope*);
     53 
     54         // Blocking call. Waits for tasks and timers, invokes the callbacks.
     55         void run();
     56 
     57         enum WaitMode { WaitForMessage, DontWaitForMessage };
     58 
     59         // Waits for a single debugger task and returns.
     60         MessageQueueWaitResult runDebuggerTask(WaitMode = WaitForMessage);
     61 
     62         void terminate();
     63         bool terminated() const { return m_messageQueue.killed(); }
     64 
     65         WorkerGlobalScope* context() const { return m_context; }
     66 
     67         // Returns true if the loop is still alive, false if it has been terminated.
     68         bool postTask(PassOwnPtr<ExecutionContextTask>);
     69 
     70         void postTaskAndTerminate(PassOwnPtr<ExecutionContextTask>);
     71 
     72         // Returns true if the loop is still alive, false if it has been terminated.
     73         bool postDebuggerTask(PassOwnPtr<ExecutionContextTask>);
     74 
     75     private:
     76         friend class RunLoopSetup;
     77         MessageQueueWaitResult run(MessageQueue<blink::WebThread::Task>&, WaitMode);
     78 
     79         // Runs any clean up tasks that are currently in the queue and returns.
     80         // This should only be called when the context is closed or loop has been terminated.
     81         void runCleanupTasks();
     82 
     83         MessageQueue<blink::WebThread::Task> m_messageQueue;
     84         MessageQueue<blink::WebThread::Task> m_debuggerMessageQueue;
     85         OwnPtr<WorkerSharedTimer> m_sharedTimer;
     86         WorkerGlobalScope* m_context;
     87         int m_nestedCount;
     88     };
     89 
     90 } // namespace WebCore
     91 
     92 #endif // WorkerRunLoop_h
     93