senf/PPI/IdleEvent.hh

   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 /** \file
  24     \brief IdleEvent public header */
  25
  26 #ifndef HH_SENF_PPI_IdleEvent_
  27 #define HH_SENF_PPI_IdleEvent_ 1
  28
  29 // Custom includes
  30 #include <senf/Scheduler/TimerEvent.hh>
  31 #include "Events.hh"
  32
  33 //#include "IdleEvent.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38
  39     /** \brief Continually signaled event
  40
  41         An IdleEvent is signaled continually and repeatedly while enabled. It will consume 100% of
  42         available CPU resources. The resource usage is controlled by adequate event throttling.
  43
  44         \ingroup event_group
  45      */
  46     class IdleEvent
  47         : public EventImplementation<>
  48     {
  49     public:
  50         IdleEvent(std::string const & name = "");
  51
  52     private:
  53         virtual void v_enable();
  54         virtual void v_disable();
  55
  56         void cb();
  57
  58         scheduler::TimerEvent timer_;
  59     };
  60
  61 }}
  62
  63
  64 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  65 #include "IdleEvent.cci"
  66 //#include "IdleEvent.ct"
  67 //#include "IdleEvent.cti"
  68 #endif
  69
  70 \f
  71 // Local Variables:
  72 // mode: c++
  73 // fill-column: 100
  74 // comment-column: 40
  75 // c-file-style: "senf"
  76 // indent-tabs-mode: nil
  77 // ispell-local-dictionary: "american"
  78 // compile-command: "scons -u test"
  79 // End: