X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketRegistry.hh;h=2311f3eba1c2434ee36055d4e7621fb270b0ffcc;hb=c45c112ae88196ea8da9c5a9efb0e167196744d2;hp=1fa7d99f8b161dc408d2d184762050a29470a3f8;hpb=412024ed31a4ab4eaea7a4165a434f8efebee325;p=senf.git
diff --git a/Packets/PacketRegistry.hh b/Packets/PacketRegistry.hh
index 1fa7d99..2311f3e 100644
--- a/Packets/PacketRegistry.hh
+++ b/Packets/PacketRegistry.hh
@@ -40,22 +40,22 @@
namespace senf {
- /** \brief Packet registration facility
+ /** \brief %Packet registration facility
- The PacketRegistry provides a generic facility to associate an arbitrary key with
+ The %PacketRegistry provides a generic facility to associate an arbitrary key with
Packets. Example keys are Ethertype or IP protocols.
- Every PacketRegistry is identified by a type tag:
+ Every %PacketRegistry is identified by a type tag:
\code
struct SomeTag {
typedef some_key_type key_t;
};
\endcode
- The key type can be an arbitrary value type. The PacketRegistry for this Tag can then be
+ The key type can be an arbitrary value type. The %PacketRegistry for this Tag can then be
accessed using senf::PacketRegistry::
.
- The PacketRegistry class has only static members and provides access to the packet
- registry. It allows two-way lookup either by key or by packet type.
+ The %PacketRegistry class has only static members and provides access to the packet
+ registry. It allows two-way lookup either by key or by packet type.
\code
senf::Packet::factory_t factory (senf::PacketRegistry::lookup(some_key).factory());
@@ -78,7 +78,7 @@ namespace senf {
static registration only works when the symbol is included into the final binary. To force
this inclusion, you should not put packet registrations into a library but into an object
file.
-
+
\ingroup packet_module
*/
template
@@ -110,11 +110,12 @@ namespace senf {
Register \a PacketType in the packet registry \a Tag under the given \a key.
- \par Preconditions: The given \a key must be unique and not be assigned to any other
- packet class in this registry. The Packet must not already be registered in the
+ \par Preconditions:
+ The given \a key must be unique and not be assigned to any other
+ packet class in this registry. The %Packet must not already be registered in the
registry.
- \param PacketType ConcretePacket instantiation of packet to register
+ \tparam PacketType ConcretePacket instantiation of packet to register
\param key The key of the packet
*/
template
@@ -124,7 +125,7 @@ namespace senf {
Return the key of \a PacketType as registered in the \a Tag registry
- \param PacketType packet of which the key is requested
+ \tparam PacketType packet of which the key is requested
\returns key of the packet
\throws PacketTypeNotRegistered if the packet type is not found in the registry.
*/
@@ -135,7 +136,7 @@ namespace senf {
Return the key of \a PacketType as registered in the \a Tag registry
- \param PacketType packet of which the key is requested
+ \tparam PacketType packet of which the key is requested
\returns key of the packet wrapped in a boost::optional or
an unbound optional, if the key is not found.
@@ -150,25 +151,24 @@ namespace senf {
\param packet The packet of which the key is requested
\returns key of the packet
\throws PacketTypeNotRegistered if the packet type is not found in the registry.
- */
- static typename Tag::key_t key(Packet packet);
+ */
+ static typename Tag::key_t key(Packet const & packet);
/** \brief Find key of a packet
Return the key of \a packet, an arbitrary packet, as registered in the \a Tag registry.
- \param packet The
-packet of which the key is requested
+ \param packet The packet of which the key is requested
\returns key of the packet wrapped in a boost::optional or
an unbound optional, if the key is not found.
*/
- static typename boost::optional key(Packet packet, NoThrow_t);
+ static typename boost::optional key(Packet const & packet, NoThrow_t);
/** \brief Lookup a packet by it's key
-
+
\throws PacketTypeNotRegistered if the \a key is not found in the registry
- \return Packet entry for given \a key
+ \return %Packet entry for given \a key
*/
static PkReg_Entry const & lookup(typename Tag::key_t key);
@@ -229,7 +229,7 @@ packet of which the key is requested
#include "PacketRegistry.cti"
#endif
-
+
// Local Variables:
// mode: c++
// fill-column: 100