Packets: Implement PacketRegistry priority support
[senf.git] / senf / Packets / PacketRegistry.ct
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 non-inline template implementation */
25
26 #include "PacketRegistry.ih"
27
28 // Custom includes
29 #include <senf/Utils/senfassert.hh>
30 #include <iostream>
31 #include <iomanip>
32 #include <cmath>
33 #include <senf/Utils/TypeInfo.hh>
34 #include <senf/Utils/Format.hh>
35
36 #define prefix_
37 ///////////////////////////////ct.p////////////////////////////////////////
38
39 ///////////////////////////////////////////////////////////////////////////
40 // senf::detail::PacketRegistryImpl<KeyType>::Entry
41
42 template <class KeyType>
43 prefix_ senf::detail::PacketRegistryImpl<KeyType>::Entry::Entry(KeyType const & key_,
44                                                                 int priority_)
45     : key (key_), priority (priority_)
46 {}
47
48 template <class KeyType>
49 prefix_ senf::detail::PacketRegistryImpl<KeyType>::Entry::~Entry()
50 {}
51
52 ///////////////////////////////////////////////////////////////////////////
53 // senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>
54
55 template <class KeyType>
56 template <class PacketType>
57 prefix_ senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::
58 EntryImpl(KeyType const & key, int priority)
59     : Entry (key, priority)
60 {}
61
62 template <class KeyType>
63 template <class PacketType>
64 prefix_ senf::Packet::factory_t
65 senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::factory()
66     const
67 {
68     return PacketType::factory();
69 }
70
71 template <class KeyType>
72 template <class PacketType>
73 prefix_ std::string senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::name()
74     const
75 {
76     return prettyName(typeid(PacketType));
77 }
78
79 template <class KeyType>
80 template <class PacketType>
81 prefix_ std::type_info const &
82 senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::type()
83     const
84 {
85     return typeid(PacketType);
86 }
87
88 ///////////////////////////////////////////////////////////////////////////
89 // senf::PacketRegistry<Tag>
90
91 template <class Tag>
92 prefix_ typename senf::PacketRegistry<Tag>::Registry &
93 senf::PacketRegistry<Tag>::registry()
94 {
95     static Registry registry (prettyName(typeid(Tag)));
96     return registry;
97 }
98
99 ///////////////////////////////////////////////////////////////////////////
100 // senf::detail::PacketRegistryImpl<KeyType>:
101
102 template <class KeyType>
103 template <class PacketType>
104 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::registerPacket(key_t key, int priority)
105 {
106     SENF_ASSERT(registry_.insert(
107                     typename Entry::ptr(new EntryImpl<PacketType>(key,priority))).second);
108 }
109
110 template <class KeyType>
111 template <class PacketType>
112 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::unregisterPacket()
113 {
114     registry_.template get<ByType>().erase(typeid(PacketType));
115 }
116
117 template <class KeyType>
118 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::unregisterPacket(key_t key, int priority)
119 {
120     // Why doesn't this work:
121     // registry_.erase(boost::make_tuple(key,priority));
122     typename Registry::iterator i (registry_.find(boost::make_tuple(key,priority)));
123     if (i != registry_.end())
124         registry_.erase(i);
125 }
126
127 template <class KeyType>
128 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::key_t
129 senf::detail::PacketRegistryImpl<KeyType>::key(senf::TypeIdValue const & type)
130 {
131     boost::optional<KeyType> k (key(type,true));
132     if (! k)
133         throw PacketTypeNotRegisteredException();
134     return *k;
135 }
136
137 template <class KeyType>
138 prefix_ boost::optional<typename senf::detail::PacketRegistryImpl<KeyType>::key_t>
139 senf::detail::PacketRegistryImpl<KeyType>::key(senf::TypeIdValue const & type, bool)
140 {
141     typedef typename Registry::template index<ByType>::type TypeIndex;
142     TypeIndex const & typeIndex (registry_.template get<ByType>());
143     typename TypeIndex::const_iterator i (typeIndex.find(type.id()));
144     if (i == typeIndex.end())
145         return boost::optional<key_t>();
146     return (*i)->key;
147 }
148
149 template <class KeyType>
150 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::Entry const &
151 senf::detail::PacketRegistryImpl<KeyType>::lookup(key_t key)
152 {
153     Entry const * e (lookup(key, true));
154     if (!e)
155         throw PacketTypeNotRegisteredException();
156     return *e;
157 }
158
159 template <class KeyType>
160 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::Entry const *
161 senf::detail::PacketRegistryImpl<KeyType>::lookup(key_t key, bool)
162 {
163     typedef typename Registry::template index<ByKey>::type KeyIndex;
164     KeyIndex const & keyIndex (registry_.template get<ByKey>());
165     typename KeyIndex::const_iterator i (keyIndex.lower_bound(key));
166     if (i == keyIndex.end() || (*i)->key != key)
167         return 0;
168     return i->get();
169 }
170
171 template <class KeyType>
172 prefix_ bool senf::detail::PacketRegistryImpl<KeyType>::v_empty()
173     const
174 {
175     return registry_.empty();
176 }
177
178 template <class KeyType>
179 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::v_dump(std::ostream & os)
180     const
181 {
182     typedef typename Registry::template index<ByKey>::type KeyIndex;
183     KeyIndex const & keyIndex (registry_.template get<ByKey>());
184     for (typename KeyIndex::iterator i (keyIndex.begin()), i_end (keyIndex.end());
185          i != i_end; ++i) {
186         std::string n ((*i)->name());
187         senf::detail::DumpKey<KeyType>::dump((*i)->key, os);
188         os << ' ' << std::setw(6) << (*i)->priority << ' ' << n.substr(21,n.size()-22) << '\n';
189     }
190 }
191
192 template <class KeyType>
193 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::v_clear()
194 {
195     registry_.clear();
196 }
197
198 ///////////////////////////////////////////////////////////////////////////
199 // senf::detail::DumpKey<KeyType,is_integral>
200
201 template <class KeyType, bool is_integral>
202 prefix_ void senf::detail::DumpKey<KeyType,is_integral>::dump(KeyType const & v,
203                                                               std::ostream & os)
204 {
205     os << "  " << std::setw(16) << std::left << v << std::setw(0) << std::right;
206 }
207
208 // senf::detail::DumpKey<KeyType, true>
209
210 template <class KeyType>
211 prefix_ void senf::detail::DumpKey<KeyType, true>::dump(KeyType const & v, std::ostream & os)
212 {
213     os << "  " << senf::format::dumpint(v);
214 }
215
216 ///////////////////////////////ct.e////////////////////////////////////////
217 #undef prefix_
218
219 \f
220 // Local Variables:
221 // mode: c++
222 // fill-column: 100
223 // c-file-style: "senf"
224 // indent-tabs-mode: nil
225 // ispell-local-dictionary: "american"
226 // compile-command: "scons -u test"
227 // comment-column: 40
228 // End: