X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketRegistry.hh;h=2311f3eba1c2434ee36055d4e7621fb270b0ffcc;hb=92f8630b75f3ef50e73c48cde58645dcd1534e27;hp=8f342ebb9004d150f8379d59d2cea0db881b4427;hpb=1d247d12d1759ffd77f456efe3a52f03dd289994;p=senf.git diff --git a/Packets/PacketRegistry.hh b/Packets/PacketRegistry.hh index 8f342eb..2311f3e 100644 --- a/Packets/PacketRegistry.hh +++ b/Packets/PacketRegistry.hh @@ -23,13 +23,14 @@ /** \file \brief PacketRegistry public header */ -#ifndef HH_PacketRegistryImpl_ -#define HH_PacketRegistryImpl_ 1 +#ifndef HH_SENF_Packets_PacketRegistry_ +#define HH_SENF_Packets_PacketRegistry_ 1 // Custom includes #include #include // for boost::noncopyable #include +#include #include "../Utils/Exception.hh" #include "Packet.hh" @@ -39,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()); @@ -77,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 @@ -109,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 @@ -123,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. */ @@ -134,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. @@ -149,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); @@ -200,7 +201,7 @@ packet of which the key is requested # define SENF_PACKET_REGISTRY_REGISTER( registry, value, type ) \ namespace { \ senf::PacketRegistry< registry >::RegistrationProxy< type > \ - packetRegistration_ ## __LINE__ ( value ); \ + BOOST_PP_CAT(packetRegistration_, __LINE__) ( value ); \ } /** \brief Dump all packet registries @@ -221,14 +222,14 @@ packet of which the key is requested ///////////////////////////////hh.e//////////////////////////////////////// #endif -#if !defined(HH_Packets__decls_) && !defined(HH_PacketRegistryImpl_i_) -#define HH_PacketRegistryImpl_i_ +#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketRegistry_i_) +#define HH_SENF_Packets_PacketRegistry_i_ #include "PacketRegistry.cci" #include "PacketRegistry.ct" #include "PacketRegistry.cti" #endif - + // Local Variables: // mode: c++ // fill-column: 100