Packets: Add short documentation for most internal classes
[senf.git] / Packets / PacketRegistry.ih
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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 "typeidvalue.hh"
32
33 ///////////////////////////////ih.p////////////////////////////////////////
34
35 namespace senf {
36 namespace detail {
37     
38     /** \brief Internal
39         \internal
40      */
41     template <class PacketType>
42     struct PkReg_EntryImpl
43         : public PkReg_Entry
44     {
45         virtual Packet::factory_t factory() const;
46     };
47
48     /** \brief Internal
49         \internal
50      */
51     template <class KeyType>
52     class PacketRegistryImpl 
53         : private boost::noncopyable
54     {
55     public:
56         ///////////////////////////////////////////////////////////////////////////
57         // Types
58
59         typedef KeyType key_t;
60
61         typedef PkReg_Entry Entry;
62
63         ///////////////////////////////////////////////////////////////////////////
64         ///\name Structors and default members
65         ///@{
66
67         // default default constructor
68         // no copy constructor
69         // no copy assignment
70         // default destructor
71         // no conversion constructors
72
73         ///@}
74         ///////////////////////////////////////////////////////////////////////////
75
76         template <class PacketType>
77         void registerPacket(key_t key);
78
79         key_t key(senf::TypeIdValue const & type);
80         boost::optional<key_t> key(senf::TypeIdValue const & type, bool);
81
82         Entry const & lookup(key_t key);
83         Entry const * lookup(key_t key, bool);
84
85     protected:
86
87     private:
88         typedef boost::intrusive_ptr<Entry> Entry_ptr;
89         typedef std::map<key_t, Entry_ptr> PacketMap;
90         typedef std::map<senf::TypeIdValue, key_t> ReversePacketMap;
91
92         PacketMap registry_;
93         ReversePacketMap reverseRegistry_;
94     };
95
96 }}
97
98 ///////////////////////////////ih.e////////////////////////////////////////
99 #endif
100
101 \f
102 // Local Variables:
103 // mode: c++
104 // fill-column: 100
105 // c-file-style: "senf"
106 // indent-tabs-mode: nil
107 // ispell-local-dictionary: "american"
108 // compile-command: "scons -u test"
109 // comment-column: 40
110 // End: