Move include files in debian packge into 'senf' subdirectory
[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 "../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     };
48
49     /** \brief Internal: Singleton class implementing the packet registry.
50
51         \internal
52      */
53     template <class KeyType>
54     class PacketRegistryImpl 
55         : private boost::noncopyable
56     {
57     public:
58         ///////////////////////////////////////////////////////////////////////////
59         // Types
60
61         typedef KeyType key_t;
62
63         typedef PkReg_Entry Entry;
64
65         ///////////////////////////////////////////////////////////////////////////
66         ///\name Structors and default members
67         ///@{
68
69         // default default constructor
70         // no copy constructor
71         // no copy assignment
72         // default destructor
73         // no conversion constructors
74
75         ///@}
76         ///////////////////////////////////////////////////////////////////////////
77
78         template <class PacketType>
79         void registerPacket(key_t key);
80
81         key_t key(senf::TypeIdValue const & type);
82         boost::optional<key_t> key(senf::TypeIdValue const & type, bool);
83
84         Entry const & lookup(key_t key);
85         Entry const * lookup(key_t key, bool);
86
87     protected:
88
89     private:
90         typedef boost::intrusive_ptr<Entry> Entry_ptr;
91         typedef std::map<key_t, Entry_ptr> PacketMap;
92         typedef std::map<senf::TypeIdValue, key_t> ReversePacketMap;
93
94         PacketMap registry_;
95         ReversePacketMap reverseRegistry_;
96     };
97
98 }}
99
100 ///////////////////////////////ih.e////////////////////////////////////////
101 #endif
102
103 \f
104 // Local Variables:
105 // mode: c++
106 // fill-column: 100
107 // c-file-style: "senf"
108 // indent-tabs-mode: nil
109 // ispell-local-dictionary: "american"
110 // compile-command: "scons -u test"
111 // comment-column: 40
112 // End: