PPI/AnnotationRouter.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   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 AnnotationRouter public header */
  25
  26 #ifndef HH_SENF_PPI_AnnotationRouter_
  27 #define HH_SENF_PPI_AnnotationRouter_ 1
  28
  29 // Custom includes
  30 #include <boost/ptr_container/ptr_map.hpp>
  31 #include "Module.hh"
  32 #include "Connectors.hh"
  33
  34 //#include "AnnotationRouter.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace ppi {
  39 namespace module {
  40
  41     /** \brief Route packets to destination according to some annotation value
  42
  43         This router takes packet on a single input and directs them to one of it outputs depending
  44         on a \link packet_usage_annotation packet annotation\endlink. Each output connected
  45         will be associated with a single annotation value. Incoming packets for which no matching
  46         output is found are directed to a default output. If this output is left unconnected, those
  47         packets will be dropped.
  48
  49         The \a AnnotationType template parameter defines the routing key. This annotation must
  50         support the following operations:
  51         \li Comparison with '<'
  52         \li Copy-construction
  53         \li Output streaming to an ostream via '<<'
  54
  55         The following annotation can be used to route the packets according to a mac address.
  56         \code
  57         struct TargetInterface
  58         {
  59             senf::MACAddress mac;
  60
  61             bool operator< (TargetInterface const & other)
  62                 { return mac < other.mac; }
  63
  64             TargetInterface(senf::MACAddress const & m)
  65                 : mac (m) {}
  66         };
  67
  68         std::ostream & operator<<(std::ostream & os, TargetInterface const & v)
  69             { os << v.mac; return os; }
  70         \endcode
  71
  72         The additional senf::MACAddress constructor allows to construct an instance directly from a
  73         mac address and allows to pass a senf::MACAddress value as routing key directly:
  74
  75         \code
  76         senf::ppi::module::AnnotationRouter router;
  77
  78         senf::ppi::connect(router, target1, senf::MACAddress::from_string("00:1a:2b:04:06:08"));
  79         \endcode
  80
  81         The special senf::ppi::connect() overload takes a third argument, the routing key. This must
  82         be an AnnotationType value or must be (explicitly) convertible to AnnotationType.
  83
  84         The input will be throttled whenever any of the outputs except \a defaultOutput are
  85         throttled.
  86
  87         \ingroup routing_modules
  88
  89         \todo Call Module::v_init() on every connection change and remove disconnected connections
  90         from the container
  91      */
  92     template <class AnnotationType>
  93     class AnnotationRouter : public Module
  94     {
  95         SENF_PPI_MODULE(AnnotationRouter);
  96     public:
  97         connector::PassiveInput<> input;
  98         connector::ActiveOutput<> defaultOutput;
  99
 100         AnnotationRouter();
 101
 102         struct DuplicateKeyException : public senf::Exception
 103         { DuplicateKeyException(AnnotationType const & key)
 104               : senf::Exception("Duplicate senf::ppi::module::AnnotationRouter routing key ")
 105                 { append(boost::lexical_cast<std::string>(key)); } };
 106
 107     private:
 108         connector::ActiveOutput<> & newOutput(AnnotationType const & key);
 109
 110 #ifndef DOXYGEN
 111         // I didn't get template friend functions to work ...
 112     public:
 113 #endif
 114         template <class Target>
 115         connector::GenericActiveOutput & connect(Target & target, AnnotationType const & key);
 116
 117     private:
 118         void request();
 119
 120         typedef boost::ptr_map<AnnotationType, connector::ActiveOutput<> > Outputs;
 121         Outputs outputs_;
 122     };
 123
 124 }
 125
 126 #ifndef DOXYGEN
 127
 128     template <class Target, class AnnotationType, class ArgType>
 129     connector::GenericActiveOutput & connect(
 130         module::AnnotationRouter<AnnotationType> & source, Target & target,
 131         ArgType const & key);
 132
 133 #endif
 134
 135 }}
 136
 137 ///////////////////////////////hh.e////////////////////////////////////////
 138 //#include "AnnotationRouter.cci"
 139 #include "AnnotationRouter.ct"
 140 #include "AnnotationRouter.cti"
 141 #endif
 142
 143 \f
 144 // Local Variables:
 145 // mode: c++
 146 // fill-column: 100
 147 // comment-column: 40
 148 // c-file-style: "senf"
 149 // indent-tabs-mode: nil
 150 // ispell-local-dictionary: "american"
 151 // compile-command: "scons -u test"
 152 // End: