Search:

SENF Extensible Network Framework

  • Home
  • Download
  • Wiki
  • BerliOS
  • ChangeLog
  • Browse SVN
  • Bug Tracker
  • Overview
  • Examples
  • HowTos
  • Glossary
  • PPI
  • Packets
  • Scheduler
  • Socket
  • Utils
  • Console
  • Daemon
  • Logger
  • Termlib
  • Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

IdleEvent.hh

Go to the documentation of this file.
00001 // $Id: IdleEvent.hh 1742 2010-11-04 14:51:56Z g0dil $
00002 //
00003 // Copyright (C) 2009
00004 // Fraunhofer (FOKUS)
00005 // Competence Center NETwork research (NET), St. Augustin, GERMANY
00006 //     Stefan Bund <g0dil@berlios.de>
00007 //
00008 // This program is free software; you can redistribute it and/or modify
00009 // it under the terms of the GNU General Public License as published by
00010 // the Free Software Foundation; either version 2 of the License, or
00011 // (at your option) any later version.
00012 //
00013 // This program is distributed in the hope that it will be useful,
00014 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00015 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016 // GNU General Public License for more details.
00017 //
00018 // You should have received a copy of the GNU General Public License
00019 // along with this program; if not, write to the
00020 // Free Software Foundation, Inc.,
00021 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00022 
00026 #ifndef HH_SENF_Scheduler_IdleEvent_
00027 #define HH_SENF_Scheduler_IdleEvent_ 1
00028 
00029 // Custom includes
00030 #include <boost/function.hpp>
00031 #include <senf/boost_intrusive/ilist_hook.hpp>
00032 #include "FIFORunner.hh"
00033 
00034 //#include "IdleEvent.mpp"
00035 //-/////////////////////////////////////////////////////////////////////////////////////////////////
00036 
00037 namespace senf {
00038 namespace scheduler {
00039 
00040 namespace detail {
00041     struct IdleEventListTag;
00042     typedef boost::intrusive::ilist_base_hook<IdleEventListTag> IdleEventListBase;
00043     class IdleEventDispatcher;
00044 }
00045 
00046     class IdleEvent
00047         : public detail::FIFORunner::TaskInfo,
00048           public detail::IdleEventListBase
00049     {
00050     public:
00051         //-////////////////////////////////////////////////////////////////////////
00052         // Types
00053 
00054         typedef boost::function<void ()> Callback;
00055 
00056         //-////////////////////////////////////////////////////////////////////////
00058         //\{
00059 
00060         IdleEvent(std::string const & name, Callback const & cb,
00061                   bool initiallyEnabled = true);
00062         ~IdleEvent();
00063 
00064         //\}
00065         //-////////////////////////////////////////////////////////////////////////
00066 
00067         void disable();                 
00068         void enable();                  
00069 
00070         void action(Callback const & cb); 
00071 
00072     protected:
00073 
00074     private:
00075         virtual void v_run();
00076         virtual char const * v_type() const;
00077         virtual std::string v_info() const;
00078 
00079         Callback cb_;
00080 
00081         friend class detail::IdleEventDispatcher;
00082     };
00083 
00084 }}
00085 
00086 //-/////////////////////////////////////////////////////////////////////////////////////////////////
00087 #include "IdleEvent.cci"
00088 //#include "IdleEvent.ct"
00089 //#include "IdleEvent.cti"
00090 #endif
00091 
00092 
00093 // Local Variables:
00094 // mode: c++
00095 // fill-column: 100
00096 // comment-column: 40
00097 // c-file-style: "senf"
00098 // indent-tabs-mode: nil
00099 // ispell-local-dictionary: "american"
00100 // compile-command: "scons -u test"
00101 // End:

Contact: senf-dev@lists.berlios.de | © 2006-2010 Fraunhofer Institute for Open Communication Systems, Network Research