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
  28     of the standard asynchronous UNIX mainloop utilizing \c select or
  29     \c poll. The Scheduler library is based on the highly efficient
  30     (but linux specific) \c epoll() system call.
  31
  32     The library provides
  33     \li a central \ref Scheduler singleton and
  34     \li \ref ReadHelper and \ref WriteHelper templates to simplify
  35         common tasks.
  36
  37     In it's current incarnation, the library only supports network
  38     file handles (including pipes etc) and simple timers (especially
  39     it does not support asynchronous notification for on-disc file
  40     transfers etc). Additional features will be added:
  41     \li UNIX signal support
  42     \li async IO support for local (disc) file handles
  43     \li multi threading support
  44     \li IPC support for multithreaded applications
  45  */
  46
  47 }
  48
  49 \f
  50 // Local Variables:
  51 // mode: c++
  52 // fill-column: 100
  53 // c-file-style: "senf"
  54 // indent-tabs-mode: nil
  55 // ispell-local-dictionary: "american"
  56 // mode: flyspell
  57 // mode: auto-fill
  58 // End: