Utils/Console: Add short help to 'ls' output

[senf.git] / Scheduler / FIFORunner.hh

diff --git a/Scheduler/FIFORunner.hh b/Scheduler/FIFORunner.hh
index 3887a3d..6513f72 100644 (file)
--- a/Scheduler/FIFORunner.hh
+++ b/Scheduler/FIFORunner.hh
@@ -23,8 +23,8 @@
 /** \file
     \brief FIFORunner public header */
 
-#ifndef HH_FIFORunner_
-#define HH_FIFORunner_ 1
+#ifndef HH_SENF_Scheduler_FIFORunner_
+#define HH_SENF_Scheduler_FIFORunner_ 1
 
 // Custom includes
 #include <signal.h>
@@ -32,25 +32,18 @@
 #include "../boost/intrusive/ilist.hpp"
 #include "../boost/intrusive/ilist_hook.hpp"
 #include "../Utils/singleton.hh"
+#include "EventManager.hh"
 
 //#include "FIFORunner.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf { 
-
-    class Scheduler;
-
 namespace scheduler {
 
-    /** \brief Task execution scheduler
+    void restart();
 
-        The FIFORunner implements a simple FIFO scheduler for callback tasks. All tasks are held in
-        a queue. Whenever a task is run, it is moved to the end of the queue. Running the queue will
-        run all tasks which have been marked runnable. 
+namespace detail {
 
-        When running a task, it's runnable flag is always reset. The flag is set whenever an event
-        is posted for the task.
-      */
     class FIFORunner
         : public singleton<FIFORunner>
     {
@@ -63,28 +56,29 @@ namespace scheduler {
         typedef boost::intrusive::ilist<TaskListBase::value_traits<TaskInfo>, false> TaskList;
 
     public:
-        ///////////////////////////////////////////////////////////////////////////
-        // Types
-
-        /** \brief Task structure
-
-            TaskInfo is the base-class for all tasks.
-         */
         class TaskInfo 
-            : public TaskListBase
+            : public Event, 
+              public TaskListBase
         {
         public:
-            explicit TaskInfo(std::string const & name);
+            enum Priority { PRIORITY_LOW = 0, PRIORITY_NORMAL = 1, PRIORITY_HIGH = 2 };
+
+            explicit TaskInfo(std::string const & name, Priority priority=PRIORITY_NORMAL);
             virtual ~TaskInfo();
 
+            void run();
+
+            bool runnable() const;
+
         protected:
             void setRunnable();
             
         private:
-            virtual void run() = 0;
+            virtual void v_run() = 0;
+            virtual bool v_enabled() const;
 
             bool runnable_;
-            std::string name_;
+            Priority priority_;
 #       ifdef SENF_DEBUG
             std::string backtrace_;
 #       endif
@@ -92,29 +86,31 @@ namespace scheduler {
             friend class FIFORunner;
         };
 
-        ///////////////////////////////////////////////////////////////////////////
-        ///\name Structors and default members
-        ///@{
+        typedef boost::filter_iterator<
+            EventManager::IteratorFilter, TaskList::const_iterator> iterator;
 
         using singleton<FIFORunner>::instance;
         using singleton<FIFORunner>::alive;
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
-
-        void enqueue(TaskInfo * task);  ///< Add task to queue
-        void dequeue(TaskInfo * task);  ///< Remove task from queue
+        void enqueue(TaskInfo * task);
+        void dequeue(TaskInfo * task);
         
-        void run();                     ///< Run queue
+        void run();
+
+        void taskTimeout(unsigned ms);
+        unsigned taskTimeout() const;
+        void abortOnTimeout(bool flag);
+        bool abortOnTimeout() const;
 
-        void taskTimeout(unsigned ms);  ///< Set task timeout to \a ms milliseconds
-        unsigned taskTimeout() const;   ///< Get task timeout in milliseconds
+        void startWatchdog();
+        void stopWatchdog();
 
-        unsigned hangCount() const;     ///< Number of task expirations
-                                        /**< The FIFORunner manages a watchdog which checks, that a
-                                             single task does not run continuously for a longer time
-                                             or block. If a task runs for more than 1s, a warning is
-                                             printed  and the hangCount is increased. */
+        unsigned hangCount();
+
+        iterator begin() const;
+        iterator end() const;
+
+        void yield();
 
     protected:
 
@@ -124,22 +120,41 @@ namespace scheduler {
 
         static void watchdog(int, siginfo_t *, void *);
 
+        TaskList::iterator priorityEnd(TaskInfo::Priority p);
+        void run(TaskList::iterator f, TaskList::iterator l);
+        
+        struct NullTask : public TaskInfo
+        {
+            NullTask();
+            ~NullTask();
+            virtual void v_run();;
+            virtual char const * v_type() const;
+            virtual std::string v_info() const;
+        };
+
         TaskList tasks_;
         TaskList::iterator next_;
+
+        NullTask normalPriorityEnd_;
+        NullTask highPriorityEnd_;
+        
         timer_t watchdogId_;
+        bool watchdogRunning_;
         unsigned watchdogMs_;
+        bool watchdogAbort_;
         std::string runningName_;
 #   ifdef SENF_DEBUG
         std::string runningBacktrace_;
 #   endif
         unsigned watchdogCount_;
         unsigned hangCount_;
+        bool yield_;
 
+        friend void senf::scheduler::restart();
         friend class singleton<FIFORunner>;
-        friend class senf::Scheduler;
     };
 
-}}
+}}}
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #include "FIFORunner.cci"