Fix Build-Depends in debian/control

[senf.git] / Scheduler / Scheduler.hh

diff --git a/Scheduler/Scheduler.hh b/Scheduler/Scheduler.hh
index 29ba555..9f3d3cd 100644 (file)
--- a/Scheduler/Scheduler.hh
+++ b/Scheduler/Scheduler.hh
@@ -208,17 +208,18 @@ namespace senf {
     The watchdog is controlled using the watchdogTimeout(), watchdogEvents() and watchdogAbort().
     functions. 
 
-    The watchdog is implemented using a free running interval timer. The watchdog signal must \e not
-    be blocked. If signals need to be blocked for some reason, those regions will not be checked by
-    the watchdog. If a callback blocks, the watchdog has no chance to interrupt the process.
+    The watchdog is implemented using a free running interval timer. The watchdog signal (\c SIGURG)
+    must \e not be blocked. If signals need to be blocked for some reason, those regions will not be
+    checked by the watchdog. If a callback blocks, the watchdog has no chance to interrupt the
+    process.
 
     \warning Since the watchdog is free running for performance reasons, every callback must expect
         signals to happen. Signals \e will certainly happen since the watchdog signal is generated
         periodically (which does not necessarily generate a watchdog event ...)
 
-    Additional signals may occur when using using hires timers on kernel/glibc combinations which do
-    not support timerfd(). On such systems, hires timers are implemented using POSIX timers which
-    generate a considerable number of additional signals.
+    Additional signals (\c SIGALRM) may occur when using using hires timers on kernel/glibc
+    combinations which do not support timerfd(). On such systems, hires timers are implemented using
+    POSIX timers which generate a considerable number of additional signals.
 
     \todo Fix the file support to use threads (?) fork (?) and a pipe so it works reliably even
         over e.g. NFS.
@@ -232,7 +233,10 @@ namespace scheduler {
         \li a callback calls terminate()
         \li the run queue becomes empty. 
      */    
-    void process();                     
+    void process();
+
+    /** \brief \c true, if scheduler is running, \c false otherwise */
+    bool running();
 
     /** \brief Called by callbacks to terminate the main loop
 
@@ -248,6 +252,15 @@ namespace scheduler {
      */
     ClockService::clock_type eventTime(); 
 
+    /** \brief Return (approximate) current time
+
+        This call will return the current time as far as it is already known to the scheduler. If
+        the scheduler is running, this will return eventTime(), otherwise it will return
+        ClockService::now(). While the scheduler is running, this will reduce the number of system
+        calls.
+     */
+    ClockService::clock_type now();
+
     /** \brief Set watchdog timeout to \a ms milliseconds.
         
         Setting the watchdog timeout to 0 will disable the watchdog.