4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Thorsten Horstmann <tho@berlios.de>
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.
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.
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.
24 \brief GenericTLV public header */
26 #ifndef HH_SENF_Packets_GenericTLV_
27 #define HH_SENF_Packets_GenericTLV_ 1
30 #include <senf/Packets/Packets.hh>
31 #include <senf/Utils/type_traits.hh>
33 //#include "GenericTLV.hh.mpp"
34 ///////////////////////////////hh.p////////////////////////////////////////
38 /** \brief Base class for generic TLV parsers
40 This abstract base class can be used to define generic TLV parsers. The following
41 class structure is assumed:
42 \image html GenericTLV.png
44 Your TLVParser base class has to define a \c type and a \c length field:
46 struct MyTLVParserBase : public senf::PacketParserBase
48 # include SENF_PARSER()
49 SENF_PARSER_FIELD ( type, senf::UInt8Parser );
50 SENF_PARSER_FIELD_RO ( length, senf::UInt8Parser );
51 SENF_PARSER_FINALIZE ( MyTLVParserBase );
55 Your concrete TLV parsers will inherit from this base class and have to define a specific
56 value field and a \c TYPEID member:
58 struct MyConcreteTLVParser : public MyTLVParserBase
60 # include SENF_PARSER()
61 SENF_PARSER_INHERIT ( MyTLVParserBase );
62 SENF_PARSER_FIELD ( myValue, senf::UInt32Parser );
63 SENF_PARSER_FINALIZE ( MyConcreteTLVParser );
69 static const type_t::value_type TYPEID = 0x42;
73 With GenericTLVParserBase you can define a generic parser class which provides
74 members to access the value data and and to cast the parser to a concrete tlv
77 struct MyGenericTLVParser : public senf::GenericTLVParserBase<MyTLVParserBase>
79 typedef senf::GenericTLVParserBase<MyTLVParserBase> base;
80 MyGenericTLVParser(data_iterator i, state_type s) : base(i,s) {}
82 // members for your generic TLV parser...
86 If your generic TLV parser just inherits from GenericTLVParserBase and doesn't
87 add any additional functionality you can use a simple \c typedef as well:
89 typedef senf::GenericTLVParserBase<MyTLVParserBase> MyGenericTLVParser;
92 This generiv tlv parser can now be used for example in a list:
94 class MyTestPacketParser : public senf::PacketParserBase
96 # include SENF_PARSER()
97 SENF_PARSER_FIELD_RO ( list_length, senf::UInt8Parser );
98 SENF_PARSER_LIST ( tlv_list, list_length, MyGenericTLVParser );
99 SENF_PARSER_FINALIZE ( MyTestPacketParser );
103 Now, you can access the TLV parsers in the list in a generic way or you
104 can cast the parsers to some concrete tlv parser:
107 typedef MyTestPacket::Parser::tlv_list_t::container container_t;
108 container_t tlvContainer (p->tlv_list() );
109 optContainer_t::iterator listIter (tlvContainer.begin());
111 // listIter points to a MyGenericTLVParser, so you have generic access:
112 listIter->type() = 0x42;
113 listIter->value( someRangeOfValueData);
115 // cast to an instance of MyConcreteTLVParser:
116 if (listIter->is<MyConcreteTLVParser>()) {
117 MyConcreteTLVParser concreteTLVParser ( listIter->as<MyConcreteTLVParser>());
118 concreteTLVParser.myValue() = 0xabababab;
121 // add a MyConcreteTLV to the list:
122 MyConcreteTLVParser tlv ( tlvContainer.push_back_space().init<MyConcreteTLVParser>());
123 tlv.myValue() = 0xffff;
127 IPv6GenericOptionTLVParser, WLANGenericInfoElementParser, MIHGenericTLVParser
129 template <class Base>
130 class GenericTLVParserBase : public Base
133 GenericTLVParserBase(senf::PacketParserBase::data_iterator i, senf::PacketParserBase::state_type s)
136 senf::PacketParserBase::size_type bytes();
139 template <class Parser>
142 template <class Parser>
145 template <class Parser>
148 senf::PacketInterpreterBase::range value() const;
151 template<class ForwardReadableRange>
152 void value(ForwardReadableRange const & val,
153 typename boost::disable_if<senf::is_pair<ForwardReadableRange> >::type * = 0);
155 template<class First, class Second>
156 void value(std::pair<First, Second> const & val,
157 typename boost::disable_if<boost::is_convertible<First, typename Base::type_t::value_type> >::type * = 0);
159 template <class Type, class ForwardReadableRange>
160 void value(std::pair<Type, ForwardReadableRange> const & val,
161 typename boost::enable_if<boost::is_convertible<Type, typename Base::type_t::value_type> >::type * = 0);
163 template<class ForwardReadableRange>
164 void value(ForwardReadableRange const & val);
166 template <class ForwardReadableRange>
167 void value(std::pair<typename Base::type_t::value_type, ForwardReadableRange> const & val);
171 template<class ForwardReadableRange>
172 void value_(ForwardReadableRange const &range);
175 Base const & self() const;
180 ///////////////////////////////hh.e////////////////////////////////////////
181 //#include "GenericTLV.cci"
182 #include "GenericTLV.ct"
183 #include "GenericTLV.cti"
190 // comment-column: 40
191 // c-file-style: "senf"
192 // indent-tabs-mode: nil
193 // ispell-local-dictionary: "american"
194 // compile-command: "scons -u test"