Scheduler/Mainpage.dox

   1 namespace senf {
   2
   3 /** \mainpage The SENF Scheduler Library
   4
   5     The Scheduler library provides a simple yet flexible abstraction
   6     of the standard asynchronous UNIX mainloop utilizing \c select or
   7     \c poll. The Scheduler library is based on the highly efficient
   8     (but linux specific) \c epoll() system call.
   9
  10     The library provides
  11     \li a central \ref Scheduler singleton and
  12     \li \ref ReadHelper and \ref WriteHelper templates to simplify
  13         common tasks.
  14
  15     In it's current incarnation, the library only supports network
  16     file handles (including pipes etc) and simple timers (especially
  17     it does not support asynchronous notification for on-disc file
  18     transfers etc). Additional features will be added:
  19     \li UNIX signal support
  20     \li async IO support for local (disc) file handles
  21     \li multi threading support
  22     \li IPC support for multithreaded applications
  23  */
  24
  25 }
  26
  27 \f
  28 // Local Variables:
  29 // mode: c++
  30 // fill-column: 100
  31 // c-file-style: "senf"
  32 // indent-tabs-mode: nil
  33 // ispell-local-dictionary: "american"
  34 // mode: flyspell
  35 // mode: auto-fill
  36 // End: