Scheduler: Remove unneeded Socket dependency
[senf.git] / Scheduler / Mainpage.dox
index 210335b..e2d5f54 100644 (file)
@@ -24,24 +24,20 @@ namespace senf {
 
 /** \mainpage The SENF Scheduler Library
 
-    The Scheduler library provides a simple yet flexible abstraction
-    of the standard asynchronous UNIX mainloop utilizing \c select or
-    \c poll. The Scheduler library is based on the highly efficient
-    (but linux specific) \c epoll() system call.
+    The Scheduler library provides a simple yet flexible abstraction of the standard asynchronous
+    UNIX mainloop utilizing \c select or \c poll. The Scheduler library is based on the highly
+    efficient (but linux specific) \c epoll() system call.
 
     The library provides
-    \li a central \ref Scheduler singleton and
-    \li \ref ReadHelper and \ref WriteHelper templates to simplify
-        common tasks.
+    \li the ClockService as a reliable high-resolution highly accurate monotonous time source
+    \li a central \ref Scheduler %singleton and
+    \li \ref ReadHelper and \ref WriteHelper templates to simplify common tasks.
 
-    In it's current incarnation, the library only supports network
-    file handles (including pipes etc) and simple timers (especially
-    it does not support asynchronous notification for on-disc file
-    transfers etc). Additional features will be added:
-    \li UNIX signal support
-    \li async IO support for local (disc) file handles
-    \li multi threading support
-    \li IPC support for multithreaded applications
+    The Scheduler supports several types of scheduling activites:
+    \li Arbitrary file descriptors (however, local disk file-handles are not guaranteed
+        non-blocking)
+    \li Timers
+    \li UNIX Signals
  */
 
 }