senf/PPI/IdleEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief IdleEvent public header */
  30
  31 #ifndef HH_SENF_PPI_IdleEvent_
  32 #define HH_SENF_PPI_IdleEvent_ 1
  33
  34 // Custom includes
  35 #include <senf/Scheduler/TimerEvent.hh>
  36 #include "Events.hh"
  37
  38 //#include "IdleEvent.mpp"
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 namespace senf {
  42 namespace ppi {
  43
  44     /** \brief Continually signaled event
  45
  46         An IdleEvent is signaled continually and repeatedly while enabled. It will consume 100% of
  47         available CPU resources. The resource usage is controlled by adequate event throttling.
  48
  49         \ingroup event_group
  50      */
  51     class IdleEvent
  52         : public EventImplementation<>
  53     {
  54     public:
  55         IdleEvent(std::string const & name = "");
  56
  57     private:
  58         virtual void v_enable();
  59         virtual void v_disable();
  60
  61         void cb();
  62
  63         scheduler::TimerEvent timer_;
  64     };
  65
  66 }}
  67
  68
  69 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  70 #include "IdleEvent.cci"
  71 //#include "IdleEvent.ct"
  72 //#include "IdleEvent.cti"
  73 #endif
  74
  75 \f
  76 // Local Variables:
  77 // mode: c++
  78 // fill-column: 100
  79 // comment-column: 40
  80 // c-file-style: "senf"
  81 // indent-tabs-mode: nil
  82 // ispell-local-dictionary: "american"
  83 // compile-command: "scons -u test"
  84 // End: