senf/PPI/MonitorModule.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief MonitorModule public header */
  25
  26 #ifndef HH_SENF_PPI_MonitorModule_
  27 #define HH_SENF_PPI_MonitorModule_ 1
  28
  29 // Custom includes
  30 #include "Module.hh"
  31 #include "Connectors.hh"
  32
  33 //#include "MonitorModule.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38 namespace module {
  39
  40     /** \brief Base class providing simple monitor %module support
  41
  42         A monitor %module is a \ref senf::ppi::module::Module "module" which needs information
  43         about traversing packets but does not really act on the packets. Because of this, it is
  44         \e optional to connect the output: If the output is not connected, the packets will be
  45         silently dropped.
  46
  47         This allows to add monitor modules either into an existing chain or add them using an
  48         ActiveDuplicator.
  49
  50         To write a monitor %module, derive from senf::ppi::module::MonitorModule instead of
  51         senf::ppi::module and implement v_handlePacket():
  52
  53         \code
  54         class CountPackets
  55             : public senf::ppi::module::MonitorModule<>
  56         {
  57             SENF_PPI_MODULE(CountPackets);
  58         public:
  59             CountPackets() : counter_ (0u) {}
  60
  61         private:
  62             virtual void v_handlePacket(Packet const & p)
  63             { ++ counter_; }
  64
  65             unsigned counter_;
  66         };
  67         \endcode
  68
  69         You may of course add events (or even further connectors besides \c input and \c output
  70         provided by MonitorModule) to the %module.
  71
  72         \tparam PacketType type of packet expected on input and sent on output. This is also the
  73             type of the v_handlePacket() argument.
  74      */
  75     template <class PacketType=Packet>
  76     class MonitorModule : public Module
  77     {
  78     public:
  79         senf::ppi::connector::PassiveInput<PacketType> input;
  80         senf::ppi::connector::ActiveOutput<PacketType> output;
  81
  82     protected:
  83         MonitorModule();
  84
  85         virtual void v_handlePacket(PacketType const & p) = 0; ///< Called for each packet
  86
  87     private:
  88         void request();
  89         void throttle();
  90         void unthrottle();
  91     };
  92
  93
  94 }}}
  95
  96 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  97 //#include "MonitorModule.cci"
  98 #include "MonitorModule.ct"
  99 #include "MonitorModule.cti"
 100 #endif
 101
 102 \f
 103 // Local Variables:
 104 // mode: c++
 105 // fill-column: 100
 106 // comment-column: 40
 107 // c-file-style: "senf"
 108 // indent-tabs-mode: nil
 109 // ispell-local-dictionary: "american"
 110 // compile-command: "scons -u test"
 111 // End: