Utils: Revamp documentation overview and add some missing docs

[senf.git] / PPI / DebugModules.hh

diff --git a/PPI/DebugModules.hh b/PPI/DebugModules.hh
index 296dfc5..b52b871 100644 (file)
--- a/PPI/DebugModules.hh
+++ b/PPI/DebugModules.hh
@@ -28,11 +28,11 @@
 
 // Custom includes
 #include <deque>
-#include "Utils/SafeBool.hh"
-#include "Packets/Packets.hh"
+#include "../Utils/safe_bool.hh"
+#include "../Packets/Packets.hh"
 #include "Module.hh"
 #include "ActiveFeeder.hh"
-#include "Utils/Logger.hh"
+#include "../Utils/Logger.hh"
 
 //#include "DebugModules.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -75,7 +75,7 @@ namespace debug {
      */
     class ActiveSource
         : public Module, 
-          public SafeBool<ActiveSource>
+          public safe_bool<ActiveSource>
     {
         SENF_PPI_MODULE(ActiveSource);
 
@@ -109,6 +109,9 @@ namespace debug {
         connector::PassiveOutput output;
 
         PassiveSource();
+
+        void throttle();                ///< Throttle output connector
+        void unthrottle();              ///< Unthrottle output connector
         
         void submit(Packet packet);     ///< Enqueue packet
 
@@ -133,7 +136,7 @@ namespace debug {
      */
     class ActiveSink
         : public Module,
-          public SafeBool<ActiveSink>
+          public safe_bool<ActiveSink>
     {
         SENF_PPI_MODULE(ActiveSink);
 
@@ -165,9 +168,12 @@ namespace debug {
         typedef Queue::const_iterator iterator;
 
         connector::PassiveInput input;
-        
+
         PassiveSink();
 
+        void throttle();                ///< Throttle input connection
+        void unthrottle();              ///< Unthrottle input connection
+
         bool empty();                   ///< \c true, if queue is empty
         size_type size();               ///< number of packets in the queue
         iterator begin();               ///< begin iterator of packets in the queue
@@ -258,20 +264,20 @@ namespace debug {
     /** \brief Log received packets
 
         This module will log all packets sent to it's input using SENF_LOG to the given log
-        \a Stream, \a Area and \a level.
+        \a Stream, \a Area and \a Level.
      */
-    template < class Stream           = log::Debug, 
-               class Area             = log::DefaultArea, 
-               senf::log::Level level = log::VERBOSE >
-    class LogWriter
+    template < class Stream = log::Debug, 
+               class Area   = log::DefaultArea, 
+               class Level  = log::VERBOSE >
+    class LogSink
         : public module::Module
     {
-        SENF_PPI_MODULE(LogWriter);
+        SENF_PPI_MODULE(LogSink);
     public:
 
         connector::PassiveInput input;
 
-        LogWriter();
+        LogSink();
 
     private:
         void request();