senf/PPI/DiscardSink.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief DiscardSink public header */
  30
  31 #ifndef HH_SENF_PPI_DiscardSink_
  32 #define HH_SENF_PPI_DiscardSink_ 1
  33
  34 // Custom includes
  35 #include "Connectors.hh"
  36 #include "Module.hh"
  37
  38 //#include "DiscardSink.mpp"
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 namespace senf {
  42 namespace ppi {
  43 namespace module {
  44
  45     /** \brief Module discarding all received packets
  46
  47         DiscardSink will accept any number of packets and will silently discard them.
  48
  49         \ingroup io_modules
  50       */
  51     class DiscardSink
  52         : public Module
  53     {
  54         SENF_PPI_MODULE(DiscardSink);
  55     public:
  56         connector::PassiveInput<> input;
  57
  58         DiscardSink();
  59
  60     private:
  61         void request();
  62     };
  63
  64
  65 }}}
  66
  67 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  68 //#include "DiscardSink.cci"
  69 //#include "DiscardSink.ct"
  70 //#include "DiscardSink.cti"
  71 #endif
  72
  73 \f
  74 // Local Variables:
  75 // mode: c++
  76 // fill-column: 100
  77 // comment-column: 40
  78 // c-file-style: "senf"
  79 // indent-tabs-mode: nil
  80 // ispell-local-dictionary: "american"
  81 // compile-command: "scons -u test"
  82 // End: