senf/Scheduler/IdleEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   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_Scheduler_IdleEvent_
  32 #define HH_SENF_Scheduler_IdleEvent_ 1
  33
  34 // Custom includes
  35 #include <boost/function.hpp>
  36 #include <senf/boost_intrusive/ilist_hook.hpp>
  37 #include "FIFORunner.hh"
  38
  39 //#include "IdleEvent.mpp"
  40 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  41
  42 namespace senf {
  43 namespace scheduler {
  44
  45 namespace detail {
  46     struct IdleEventListTag;
  47     typedef boost::intrusive::ilist_base_hook<IdleEventListTag> IdleEventListBase;
  48     class IdleEventDispatcher;
  49 }
  50
  51     class IdleEvent
  52         : public detail::FIFORunner::TaskInfo,
  53           public detail::IdleEventListBase
  54     {
  55     public:
  56         //-////////////////////////////////////////////////////////////////////////
  57         // Types
  58
  59         typedef boost::function<void ()> Callback;
  60
  61         //-////////////////////////////////////////////////////////////////////////
  62         ///\name Structors and default members
  63         //\{
  64
  65         IdleEvent(std::string const & name, Callback const & cb,
  66                   bool initiallyEnabled = true);
  67         ~IdleEvent();
  68
  69         //\}
  70         //-////////////////////////////////////////////////////////////////////////
  71
  72         void disable();                 ///< Disable event
  73         void enable();                  ///< Enable event
  74
  75         void action(Callback const & cb); ///< Change event callback
  76
  77     protected:
  78
  79     private:
  80         virtual void v_run();
  81         virtual char const * v_type() const;
  82         virtual std::string v_info() const;
  83
  84         Callback cb_;
  85
  86         friend class detail::IdleEventDispatcher;
  87     };
  88
  89 }}
  90
  91 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  92 #include "IdleEvent.cci"
  93 //#include "IdleEvent.ct"
  94 //#include "IdleEvent.cti"
  95 #endif
  96
  97 \f
  98 // Local Variables:
  99 // mode: c++
 100 // fill-column: 100
 101 // comment-column: 40
 102 // c-file-style: "senf"
 103 // indent-tabs-mode: nil
 104 // ispell-local-dictionary: "american"
 105 // compile-command: "scons -u test"
 106 // End: