X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FAnnotationRouter.hh;h=218f0a4a51eb79f73a8989ab715b489468cbd6bc;hb=421d4e922c9856a80ed61c69db27504816180d99;hp=7eada36a6ee50828054c4bde55687313a5159060;hpb=dec815ada0f6022f479a45adc91b4e747cd20c9e;p=senf.git diff --git a/PPI/AnnotationRouter.hh b/PPI/AnnotationRouter.hh index 7eada36..218f0a4 100644 --- a/PPI/AnnotationRouter.hh +++ b/PPI/AnnotationRouter.hh @@ -38,20 +38,21 @@ namespace senf { namespace ppi { namespace module { - /** \brief Route packets to destination according to some annotation value + /** \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 \link packet_usage_annotation packet annotation\endlink. Each output connected + 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 '<' (\c LessThanCompatable concept) + \li Comparison with '<' (\c LessThanComparable 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 <<' (\c OutputStreamable concept) + \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 @@ -74,7 +75,7 @@ namespace module { mac address and allows to pass a senf::MACAddress value as routing key directly: \code - senf::ppi::module::AnnotationRouter router; + senf::ppi::module::AnnotationRouter router; senf::ppi::connect(router, target1, senf::MACAddress::from_string("00:1a:2b:04:06:08")); \endcode