X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FAnnotationRouter.hh;h=19b8332eb27cd1b5612c41d3300c4c139f7ee0b1;hb=eb89ea10c8c11d2ef12239cb037c958dec50f006;hp=a186fd5eb5766cc3e008ff3fcddfab304738173f;hpb=412024ed31a4ab4eaea7a4165a434f8efebee325;p=senf.git diff --git a/PPI/AnnotationRouter.hh b/PPI/AnnotationRouter.hh index a186fd5..19b8332 100644 --- a/PPI/AnnotationRouter.hh +++ b/PPI/AnnotationRouter.hh @@ -41,15 +41,18 @@ namespace module { /** \brief Route packets to destination according to some annotation value This router takes packet on a single input and directs them to one of it outputs depending - on a packet annotation. Each output connected will be associated with a single annotation - value. Incoming packets for which no matching output is found are directed to a default - output. If this output is left unconnected, those packets will be dropped. + on a \ref packet_usage_annotation "packet annotation". Each output connected + will be associated with a single annotation value. Incoming packets for which no matching + output is found are directed to a default output. If this output is left unconnected, those + packets will be dropped. The \a AnnotationType template parameter defines the routing key. This annotation must support the following operations: - \li Comparison with '<' - \li Copy-construction - \li Output streaming to an ostream via '<<' + \li Comparison with '<' (\c LessThanCompatable concept) + \li Copy construction and copy assignment (\c Copyable und \c Assignable concepts) + (e.g. via compiler synthesized copy constructor and assignment operator) + \li Output streaming to an ostream via '\c <<' (for error description purposes) (\c + OutputStreamable concept) The following annotation can be used to route the packets according to a mac address. \code @@ -100,7 +103,7 @@ namespace module { struct DuplicateKeyException : public senf::Exception { DuplicateKeyException(AnnotationType const & key) - : senf::Exception("Duplicate senf::ppi::module::AnnotationRouter routing key") + : senf::Exception("Duplicate senf::ppi::module::AnnotationRouter routing key ") { append(boost::lexical_cast(key)); } }; private: