4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief AnnotationRouter public header */
26 #ifndef HH_SENF_PPI_AnnotationRouter_
27 #define HH_SENF_PPI_AnnotationRouter_ 1
30 #include <boost/ptr_container/ptr_map.hpp>
31 #include <senf/Utils/String.hh>
33 #include "Connectors.hh"
34 #include "MultiConnectorMixin.hh"
36 //#include "AnnotationRouter.mpp"
37 ///////////////////////////////hh.p////////////////////////////////////////
43 /** \brief %Route packets to destination according to some annotation value
45 This router takes packet on a single input and directs them to one of it outputs depending
46 on a \ref packet_usage_annotation "packet annotation". Each output connected
47 will be associated with a single annotation value. Incoming packets for which no matching
48 output is found are directed to a default output. If this output is left unconnected, those
49 packets will be dropped.
51 The \a AnnotationType template parameter defines the routing key. This annotation must
52 support the following operations:
53 \li Comparison with '<' (\c LessThanComparable concept)
54 \li Copy construction and copy assignment (\c Copyable und \c Assignable concepts)
55 (e.g. via compiler synthesized copy constructor and assignment operator)
56 \li Output streaming to an ostream via '\c <<' (for error description purposes) (\c
57 OutputStreamable concept)
59 The following annotation can be used to route the packets according to a mac address.
61 struct TargetInterface
65 bool operator< (TargetInterface const & other)
66 { return mac < other.mac; }
68 TargetInterface(senf::MACAddress const & m)
72 std::ostream & operator<<(std::ostream & os, TargetInterface const & v)
73 { os << v.mac; return os; }
76 The additional senf::MACAddress constructor allows to construct an instance directly from a
77 mac address and allows to pass a senf::MACAddress value as routing key directly:
80 senf::ppi::module::AnnotationRouter<TargetInterface> router;
82 senf::ppi::connect(router, target1, senf::MACAddress::from_string("00:1a:2b:04:06:08"));
85 The special senf::ppi::connect() overload takes a third argument, the routing key. This must
86 be an AnnotationType value or must be (explicitly) convertible to AnnotationType.
88 The input will be throttled whenever any of the outputs except \a defaultOutput are
91 \ingroup routing_modules
93 \todo Call Module::v_init() on every connection change and remove disconnected connections
96 template <class AnnotationType>
97 class AnnotationRouter
99 public MultiConnectorMixin< AnnotationRouter<AnnotationType>,
100 connector::ActiveOutput<>,
103 SENF_PPI_MODULE(AnnotationRouter);
105 connector::PassiveInput<> input;
106 connector::ActiveOutput<> defaultOutput;
110 struct DuplicateKeyException : public senf::Exception
111 { DuplicateKeyException(AnnotationType const & key)
112 : senf::Exception("Duplicate senf::ppi::module::AnnotationRouter routing key ")
113 { append( senf::str(key)); } };
116 AnnotationType connectorSetup(connector::ActiveOutput<> & conn, AnnotationType const & key);
119 friend class MultiConnectorMixin< AnnotationRouter<AnnotationType>,
120 connector::ActiveOutput<>,
126 ///////////////////////////////hh.e////////////////////////////////////////
127 //#include "AnnotationRouter.cci"
128 #include "AnnotationRouter.ct"
129 //#include "AnnotationRouter.cti"
136 // comment-column: 40
137 // c-file-style: "senf"
138 // indent-tabs-mode: nil
139 // ispell-local-dictionary: "american"
140 // compile-command: "scons -u test"