Scheduler/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 namespace senf {
  24
  25 /** \mainpage The SENF Scheduler Library
  26
  27     The Scheduler library provides a simple yet flexible abstraction of the standard asynchronous
  28     UNIX mainloop utilizing \c select or \c poll. The Scheduler library is based on the highly
  29     efficient (but linux specific) \c epoll() system call.
  30
  31     The library provides
  32     \li the ClockService as a reliable high-resolution highly accurate monotonous time source
  33     \li a central \ref Scheduler %singleton and
  34     \li \ref ReadHelper and \ref WriteHelper templates to simplify common tasks.
  35
  36     The Scheduler supports several types of scheduling activites:
  37     \li Arbitrary file descriptors (however, local disk file-handles are not guaranteed
  38         non-blocking)
  39     \li Timers
  40     \li UNIX Signals
  41  */
  42
  43 }
  44
  45 \f
  46 // Local Variables:
  47 // mode: c++
  48 // fill-column: 100
  49 // c-file-style: "senf"
  50 // indent-tabs-mode: nil
  51 // ispell-local-dictionary: "american"
  52 // mode: flyspell
  53 // mode: auto-fill
  54 // End: