Packets/GenericTLV: added some documentation
[senf.git] / senf / Packets / GenericTLV.cti
1 // $Id$
2 //
3 // Copyright (C) 2009
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Thorsten Horstmann <tho@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 GenericTLV inline template implementation */
25
26 //#include "GenericTLV.ih"
27
28 // Custom includes
29
30 #define prefix_ inline
31 ///////////////////////////////cti.p///////////////////////////////////////
32
33 ///////////////////////////////////////////////////////////////////////////
34 // senf::GenericTLVParserBase<Base>
35
36 template <class Base>
37 prefix_ senf::PacketParserBase::size_type senf::GenericTLVParserBase<Base>::bytes()
38 {
39     return senf::bytes(self()) + this->length();
40 }
41
42 template <class Base>
43 prefix_ void senf::GenericTLVParserBase<Base>::init()
44     const
45 {
46     this->defaultInit();
47 }
48
49 template <class Base>
50 template <class Parser>
51 prefix_ Parser senf::GenericTLVParserBase<Base>::as()
52     const
53 {
54     return Parser(this->i(), this->state() );
55 }
56
57 template <class Base>
58 template <class Parser>
59 prefix_ bool senf::GenericTLVParserBase<Base>::is()
60     const
61 {
62     return this->type().value() == Parser::typeId;
63 }
64
65 template <class Base>
66 prefix_ Base & senf::GenericTLVParserBase<Base>::self()
67 {
68     return *static_cast<Base *>(this);
69 }
70
71 template <class Base>
72 prefix_ Base const & senf::GenericTLVParserBase<Base>::self()
73     const
74 {
75     return *static_cast<Base const *>(this);
76 }
77
78 template <class Base>
79 prefix_  void senf::GenericTLVParserBase<Base>::dump(std::ostream & os)
80     const 
81 {
82     GenericTLVParserRegistry<Base>::instance().dump(*this, os);
83 }
84
85 #ifndef DOXYGEN
86
87 template <class Base>
88 template <class ForwardReadableRange>
89 prefix_ void senf::GenericTLVParserBase<Base>::value(
90         ForwardReadableRange const & val,
91         typename boost::disable_if<senf::is_pair<ForwardReadableRange> >::type *)
92
93     value_( val); 
94 }
95
96 template <class Base>
97 template <class First, class Second>
98 prefix_ void senf::GenericTLVParserBase<Base>::value(
99         std::pair<First, Second> const & val,
100         typename boost::disable_if<boost::is_convertible<First, typename Base::type_t::value_type> >::type *)
101
102     value_( val); 
103 }
104
105 template <class Base>
106 template <class Type, class ForwardReadableRange>
107 prefix_ void senf::GenericTLVParserBase<Base>::value(
108         std::pair<Type, ForwardReadableRange> const & val,
109         typename boost::enable_if<boost::is_convertible<Type, typename Base::type_t::value_type> >::type *)
110
111     this->type() = val.first;
112     value_( val.second); 
113 }
114
115 #endif
116
117
118 ///////////////////////////////////////////////////////////////////////////
119 // senf::detail:GenericTLVParserRegistry_Entry<BaseParser, Parser>
120
121 template <class BaseParser, class Parser>
122 prefix_ void senf::detail::GenericTLVParserRegistry_Entry<BaseParser, Parser>::dump(
123         GenericTLVParserBase<BaseParser> const & parser, std::ostream & os)
124     const
125 {
126     (parser.template as<Parser>()).dump(os);
127 }
128
129
130 ///////////////////////////////////////////////////////////////////////////
131 // senf::GenericTLVParserRegistry<BaseParser>::RegistrationProxy<PacketParser>
132
133 template <class BaseParser>
134 template <class PacketParser>
135 prefix_ senf::GenericTLVParserRegistry<BaseParser>::RegistrationProxy<PacketParser>::RegistrationProxy()
136 {
137     GenericTLVParserRegistry<BaseParser>::instance().registerParser<PacketParser>();
138 };
139
140 ///////////////////////////////cti.e///////////////////////////////////////
141 #undef prefix_
142
143 \f
144 // Local Variables:
145 // mode: c++
146 // fill-column: 100
147 // comment-column: 40
148 // c-file-style: "senf"
149 // indent-tabs-mode: nil
150 // ispell-local-dictionary: "american"
151 // compile-command: "scons -u test"
152 // End: