Packets/PacketRegistry.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief PacketRegistry internal header */
  25
  26 #ifndef IH_PacketRegistryImpl_
  27 #define IH_PacketRegistryImpl_ 1
  28
  29 // Custom includes
  30 #include <boost/intrusive_ptr.hpp>
  31 #include "../Utils/TypeIdValue.hh"
  32
  33 ///////////////////////////////ih.p////////////////////////////////////////
  34
  35 namespace senf {
  36 namespace detail {
  37
  38     /** \brief Internal: Registry entry implementation for a specific packet type
  39
  40         \internal
  41      */
  42     template <class PacketType>
  43     struct PkReg_EntryImpl
  44         : public PkReg_Entry
  45     {
  46         virtual Packet::factory_t factory() const;
  47         virtual std::string name() const;
  48     };
  49
  50     /** \brief Internal: Singleton class implementing the packet registry.
  51
  52         \internal
  53      */
  54     template <class KeyType>
  55     class PacketRegistryImpl
  56         : private boost::noncopyable
  57     {
  58     public:
  59         typedef KeyType key_t;
  60         typedef PkReg_Entry Entry;
  61
  62     private:
  63         typedef boost::intrusive_ptr<Entry> Entry_ptr;
  64         typedef std::map<key_t, Entry_ptr> PacketMap;
  65         typedef std::map<senf::TypeIdValue, key_t> ReversePacketMap;
  66
  67     public:
  68         ///////////////////////////////////////////////////////////////////////////
  69         // Types
  70
  71         ///////////////////////////////////////////////////////////////////////////
  72         ///\name Structors and default members
  73         ///@{
  74
  75         // default default constructor
  76         // no copy constructor
  77         // no copy assignment
  78         // default destructor
  79         // no conversion constructors
  80
  81         ///@}
  82         ///////////////////////////////////////////////////////////////////////////
  83
  84         template <class PacketType>
  85         void registerPacket(key_t key);
  86
  87         key_t key(senf::TypeIdValue const & type);
  88         boost::optional<key_t> key(senf::TypeIdValue const & type, bool);
  89
  90         Entry const & lookup(key_t key);
  91         Entry const * lookup(key_t key, bool);
  92
  93     protected:
  94
  95     private:
  96         PacketMap registry_;
  97         ReversePacketMap reverseRegistry_;
  98     };
  99
 100 }}
 101
 102 ///////////////////////////////ih.e////////////////////////////////////////
 103 #endif
 104
 105 \f
 106 // Local Variables:
 107 // mode: c++
 108 // fill-column: 100
 109 // c-file-style: "senf"
 110 // indent-tabs-mode: nil
 111 // ispell-local-dictionary: "american"
 112 // compile-command: "scons -u test"
 113 // comment-column: 40
 114 // End: