X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketRegistry.hh;h=172a23399d4696ed9e18c8cf69cdc7ec222a71ed;hb=b371e9c8020d1c30d7f844819714a81db7709912;hp=e27f10660afb8d5e6cc74d53890390a86937f05c;hpb=47368f306a577d1e46df69a7f729bd3893cbe5e7;p=senf.git diff --git a/Packets/PacketRegistry.hh b/Packets/PacketRegistry.hh index e27f106..172a233 100644 --- a/Packets/PacketRegistry.hh +++ b/Packets/PacketRegistry.hh @@ -20,6 +20,8 @@ // Free Software Foundation, Inc., // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +/** \file + \brief PacketRegistry public header */ #ifndef HH_PacketRegistryImpl_ #define HH_PacketRegistryImpl_ 1 @@ -29,7 +31,6 @@ #include // for boost::noncopyable #include #include "Utils/Exception.hh" -#include "PacketInterpreter.hh" #include "Packet.hh" //#include "PacketRegistry.mpp" @@ -37,66 +38,77 @@ namespace senf { + /** \brief Registry entry + + Value returned by a registry lookup + */ struct PkReg_Entry : public intrusive_refcount { virtual ~PkReg_Entry(); - virtual PacketInterpreterBase::factory_t factory() const = 0; + virtual Packet::factory_t factory() const = 0; + ///< Get factory of the registered packet type }; namespace detail { template class PacketRegistryImpl; } /** \brief Packet registration facility - The PacketRegistry provides a generic facility to associate an - arbitrary key with Packets. Example keys are Ethertype or IP - protocols. + 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: \code - struct SomeTag { - typedef some_key_type key_t; - }; + 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 accessed using - PacketRegistry::. + 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 to register Packet - classes and to create new Packets given a key. Methods are - also provided to find the key of a 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 - PacketRegistry::registerPacket(key_of_somePacket); - p = PacketRegistry::create(some_key,begin,end); - SomeTag::key_t key = PacketRegistry::key(); + senf::Packet::factory_t factory (senf::PacketRegistry::lookup(some_key).factory()); + SomeTag::key_t key = PacketRegistry::key(); \endcode - Normally, packet classes are registered statically and not - procedurally. To this end, the RegistrationProxy is provided: + Packets can be registered either dynamically or statically. Dynamic: \code - PacketRegistry::RegistrationProxy - registerSomePacket (key_of_somePacket); + // dynamic registration + senf::PacketRegistry::registerPacket(key_of_somePacket); + + // static registration. 'registerSomePacket' is an arbitrary symbol name + senf::PacketRegistry::RegistrationProxy + registerSomePacket (key_of_somePacket); \endcode - This global variable declaration will register \c SomePacket - with the \c SomeTag registry under the key \c - key_of_somePacket. The variable \c registerSomePacket is a - dummy. It's only function is to force the call of it's - constructor during global construction time. - - The PacketRegistry's purpose is mostly to assist in - implementing the v_nextInterpreter() member of packet - facades. This is further supported by the PacketRegistryMixin - class. - - \todo Add parameterless create() method + + This global variable declaration will register \a SomePacket with the \a SomeTag registry + under the key \a key_of_somePacket. The variable \a registerSomePacket is a dummy. It's only + function is to force the call of it's constructor during global construction time. This + 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 class PacketRegistry { public: /** \brief Statically register a packet type in a PacketRegistry + + To use this class, define a global symbol in the following way: + \code + namespace { + senf::PacketRegistry::RegistrationProxy + registerPacketType (key); + } + \endcode Here \a Tag is the type tag of the registry to register the packet in, \a + PacketType is the packet to register (this is the ConcretePacket of that packet) and \a + key is the key of type \c Tag::key_t under which the packet is to be registered. \a + registerPacketType is an arbitrary name for the global symbol. */ template struct RegistrationProxy @@ -106,49 +118,74 @@ namespace senf { /** \brief Register new packet type - Register \c PacketType in the packet registry \c Tag - under the given \c key. + Register \a PacketType in the packet registry \a Tag under the given \a key. - \par Preconditions: - The given \c 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. + \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 packet to register - \param key key of the packet + \param PacketType ConcretePacket instantiation of packet to register + \param key The key of the packet */ template static void registerPacket(typename Tag::key_t key); - /** \brief Find key of a packet + /** \brief Find key of a packet type - Return the key of \c PacketType as registered in the \c - Tag registry + Return the key of \a PacketType as registered in the \a Tag registry \param 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. + \throws PacketTypeNotRegistered if the packet type is not found in the registry. */ template static typename Tag::key_t key(); + /** \brief Find key of a packet type + + Return the key of \a PacketType as registered in the \a Tag registry + + \param 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. + */ template static typename boost::optional key(NoThrow_t); + /** \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 + \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 packet, NoThrow_t); - /** \brief Lookup a packet by it's key + /** \brief Find key of a packet - Returns the packet registration registered under \a key in the \a Tag registry + Return the key of \a packet, an arbitrary packet, as registered in the \a Tag registry. - \param key Key of the packet registered - \returns Registration entry of the packet - \throws PacketTypeNotRegistered if the packet type is not found in the registry + \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); + + /** \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 */ static PkReg_Entry const & lookup(typename Tag::key_t key); + /** \brief Lookup a packet by it's key + \return Pointer to packet entry for given \a key or 0, if the key is not found in the + registry. + */ static PkReg_Entry const * lookup(typename Tag::key_t key, NoThrow_t); private: @@ -156,12 +193,19 @@ namespace senf { static Registry & registry(); }; + /** \brief Entry not found in registry + + This exception is signaled whenever a throwing lookup operation fails. + */ struct PacketTypeNotRegisteredException : public std::exception { virtual char const * what() const throw() { return "packet type not registered"; } }; } ///////////////////////////////hh.e//////////////////////////////////////// +#endif +#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_PacketRegistryImpl_i_) +#define HH_PacketRegistryImpl_i_ //#include "PacketRegistry.cci" #include "PacketRegistry.ct" #include "PacketRegistry.cti" @@ -177,3 +221,4 @@ namespace senf { // compile-command: "scons -u test" // comment-column: 40 // End: +