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 \ref packet_usage_annotation "packet annotation". 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 '<' (\c LessThanComparable concept)
  52         \li Copy construction and copy assignment (\c Copyable und \c Assignable concepts)
  53             (e.g. via compiler synthesized copy constructor and assignment operator)
  54         \li Output streaming to an ostream via '\c <<' (for error description purposes) (\c
  55             OutputStreamable concept)
  56
  57         The following annotation can be used to route the packets according to a mac address.
  58         \code
  59         struct TargetInterface
  60         {
  61             senf::MACAddress mac;
  62
  63             bool operator< (TargetInterface const & other)
  64                 { return mac < other.mac; }
  65
  66             TargetInterface(senf::MACAddress const & m)
  67                 : mac (m) {}
  68         };
  69
  70         std::ostream & operator<<(std::ostream & os, TargetInterface const & v)
  71             { os << v.mac; return os; }
  72         \endcode
  73
  74         The additional senf::MACAddress constructor allows to construct an instance directly from a
  75         mac address and allows to pass a senf::MACAddress value as routing key directly:
  76
  77         \code
  78         senf::ppi::module::AnnotationRouter<TargetInterface> router;
  79
  80         senf::ppi::connect(router, target1, senf::MACAddress::from_string("00:1a:2b:04:06:08"));
  81         \endcode
  82
  83         The special senf::ppi::connect() overload takes a third argument, the routing key. This must
  84         be an AnnotationType value or must be (explicitly) convertible to AnnotationType.
  85
  86         The input will be throttled whenever any of the outputs except \a defaultOutput are
  87         throttled.
  88
  89         \ingroup routing_modules
  90
  91         \todo Call Module::v_init() on every connection change and remove disconnected connections
  92         from the container
  93      */
  94     template <class AnnotationType>
  95     class AnnotationRouter : public Module
  96     {
  97         SENF_PPI_MODULE(AnnotationRouter);
  98     public:
  99         connector::PassiveInput<> input;
 100         connector::ActiveOutput<> defaultOutput;
 101
 102         AnnotationRouter();
 103
 104         struct DuplicateKeyException : public senf::Exception
 105         { DuplicateKeyException(AnnotationType const & key)
 106               : senf::Exception("Duplicate senf::ppi::module::AnnotationRouter routing key ")
 107                 { append(boost::lexical_cast<std::string>(key)); } };
 108
 109     private:
 110         connector::ActiveOutput<> & newOutput(AnnotationType const & key);
 111
 112 #ifndef DOXYGEN
 113         // I didn't get template friend functions to work ...
 114     public:
 115 #endif
 116         template <class Target>
 117         connector::GenericActiveOutput & connect(Target & target, AnnotationType const & key);
 118
 119     private:
 120         void request();
 121
 122         typedef boost::ptr_map<AnnotationType, connector::ActiveOutput<> > Outputs;
 123         Outputs outputs_;
 124     };
 125
 126 }
 127
 128 #ifndef DOXYGEN
 129
 130     template <class Target, class AnnotationType, class ArgType>
 131     connector::GenericActiveOutput & connect(
 132         module::AnnotationRouter<AnnotationType> & source, Target & target,
 133         ArgType const & key);
 134
 135 #endif
 136
 137 }}
 138
 139 ///////////////////////////////hh.e////////////////////////////////////////
 140 //#include "AnnotationRouter.cci"
 141 #include "AnnotationRouter.ct"
 142 #include "AnnotationRouter.cti"
 143 #endif
 144
 145 \f
 146 // Local Variables:
 147 // mode: c++
 148 // fill-column: 100
 149 // comment-column: 40
 150 // c-file-style: "senf"
 151 // indent-tabs-mode: nil
 152 // ispell-local-dictionary: "american"
 153 // compile-command: "scons -u test"
 154 // End: