senf/PPI/DiscardSink.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   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 DiscardSink public header */
  25
  26 #ifndef HH_SENF_PPI_DiscardSink_
  27 #define HH_SENF_PPI_DiscardSink_ 1
  28
  29 // Custom includes
  30 #include "Connectors.hh"
  31 #include "Module.hh"
  32
  33 //#include "DiscardSink.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38 namespace module {
  39
  40     /** \brief Module discarding all received packets
  41
  42         DiscardSink will accept any number of packets and will silently discard them.
  43
  44         \ingroup io_modules
  45       */
  46     class DiscardSink
  47         : public Module
  48     {
  49         SENF_PPI_MODULE(DiscardSink);
  50     public:
  51         connector::PassiveInput<> input;
  52
  53         DiscardSink();
  54
  55     private:
  56         void request();
  57     };
  58
  59
  60 }}}
  61
  62 ///////////////////////////////hh.e////////////////////////////////////////
  63 //#include "DiscardSink.cci"
  64 //#include "DiscardSink.ct"
  65 //#include "DiscardSink.cti"
  66 #endif
  67
  68 \f
  69 // Local Variables:
  70 // mode: c++
  71 // fill-column: 100
  72 // comment-column: 40
  73 // c-file-style: "senf"
  74 // indent-tabs-mode: nil
  75 // ispell-local-dictionary: "american"
  76 // compile-command: "scons -u test"
  77 // End: