X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FIdleEvent.hh;h=128dcba8a34524bf8cd430047b69e83b269b5d60;hb=b8ca4a544cce3e6023bb56b712a03d6362f2bb79;hp=3064380021e9a29ada1069f6cf97847902fa7fc5;hpb=0327b3f303ea2a61d44a30bfaac022874dcf2a0d;p=senf.git

diff --git a/PPI/IdleEvent.hh b/PPI/IdleEvent.hh
index 3064380..128dcba 100644
--- a/PPI/IdleEvent.hh
+++ b/PPI/IdleEvent.hh
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -23,8 +23,8 @@
 /** \file
     \brief IdleEvent public header */
 
-#ifndef HH_IdleEvent_
-#define HH_IdleEvent_ 1
+#ifndef HH_SENF_PPI_IdleEvent_
+#define HH_SENF_PPI_IdleEvent_ 1
 
 // Custom includes
 #include "Events.hh"
@@ -35,6 +35,13 @@
 namespace senf {
 namespace ppi {
 
+    /** \brief Continually signaled event
+
+        An IdleEvent is signaled continually and repeatedly while enabled. It will consume 100% of
+        available CPU resources. The resource usage is controlled by adequate event throttling.
+        
+        \ingroup event_group
+     */
     class IdleEvent
         : public EventImplementation<>
     {
@@ -49,7 +56,7 @@ namespace ppi {
 
         void cb();
         
-        unsigned id_;
+        scheduler::TimerEvent timer_;
     };
 
 }}