4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief FIFORunner public header */
26 #ifndef HH_FIFORunner_
27 #define HH_FIFORunner_ 1
31 #include <boost/utility.hpp>
32 #include "../boost/intrusive/ilist.hpp"
33 #include "../boost/intrusive/ilist_hook.hpp"
34 #include "../Utils/singleton.hh"
36 //#include "FIFORunner.mpp"
37 ///////////////////////////////hh.p////////////////////////////////////////
45 /** \brief Task execution scheduler
47 The FIFORunner implements a simple FIFO scheduler for callback tasks. All tasks are held in
48 a queue. Whenever a task is run, it is moved to the end of the queue. Running the queue will
49 run all tasks which have been marked runnable.
51 When running a task, it's runnable flag is always reset. The flag is set whenever an event
52 is posted for the task.
55 : public singleton<FIFORunner>
62 typedef boost::intrusive::ilist_base_hook<TaskListTag> TaskListBase;
63 typedef boost::intrusive::ilist<TaskListBase::value_traits<TaskInfo>, false> TaskList;
66 ///////////////////////////////////////////////////////////////////////////
69 /** \brief Task structure
71 TaskInfo is the base-class for all tasks.
77 explicit TaskInfo(std::string const & name);
84 virtual void run() = 0;
89 std::string backtrace_;
92 friend class FIFORunner;
95 ///////////////////////////////////////////////////////////////////////////
96 ///\name Structors and default members
99 using singleton<FIFORunner>::instance;
100 using singleton<FIFORunner>::alive;
103 ///////////////////////////////////////////////////////////////////////////
105 void enqueue(TaskInfo * task); ///< Add task to queue
106 void dequeue(TaskInfo * task); ///< Remove task from queue
108 void run(); ///< Run queue
110 void taskTimeout(unsigned ms); ///< Set task timeout to \a ms milliseconds
111 unsigned taskTimeout() const; ///< Get task timeout in milliseconds
113 unsigned hangCount() const; ///< Number of task expirations
114 /**< The FIFORunner manages a watchdog which checks, that a
115 single task does not run continuously for a longer time
116 or block. If a task runs for more than 1s, a warning is
117 printed and the hangCount is increased. */
125 static void watchdog(int, siginfo_t *, void *);
128 TaskList::iterator next_;
130 unsigned watchdogMs_;
131 std::string runningName_;
133 std::string runningBacktrace_;
135 unsigned watchdogCount_;
138 friend class singleton<FIFORunner>;
139 friend class senf::Scheduler;
144 ///////////////////////////////hh.e////////////////////////////////////////
145 #include "FIFORunner.cci"
146 //#include "FIFORunner.ct"
147 //#include "FIFORunner.cti"
154 // comment-column: 40
155 // c-file-style: "senf"
156 // indent-tabs-mode: nil
157 // ispell-local-dictionary: "american"
158 // compile-command: "scons -u test"