--- /dev/null
+// $Id: TLVPacket.ct 469 2007-10-19 11:20:08Z tho $
+//
+// Copyright (C) 2007
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+/** \file
+ \brief TLVPacket non-inline template implementation */
+
+//#include "TLVPacket.ih"
+
+// Custom includes
+#include "TLVPacket.hh"
+
+#define prefix_
+///////////////////////////////ct.p////////////////////////////////////////
+
+template <class LengthParser>
+prefix_ void senf::TLVPacketType<LengthParser>::dump(packet p, std::ostream & os)
+{
+ os << "TLVPacket:"
+ << std::dec
+ << " type: " << unsigned(p->type()) << "\n"
+ << " length: " << unsigned(p->length()) << "\n";
+}
+
+template <class LengthParser>
+prefix_ void senf::TLVPacketType<LengthParser>::finalize(packet p)
+{
+ PacketData::size_type size = p.next().data().size();
+ if ( size > LengthParser::max_value )
+ throw(UnsuportedTLVPacketException());
+ p->length() = size;
+}
+
+template <class LengthParser>
+prefix_ senf::PacketParserBase::size_type senf::TLVPacketType<LengthParser>::initSize()
+{
+ return 4 + senf::init_bytes<LengthParser>::value;
+}
+
+template <class LengthParser>
+prefix_ senf::PacketInterpreterBase::optional_range
+senf::TLVPacketType<LengthParser>::nextPacketRange(packet p)
+{
+ if (p.data().size() < 5)
+ return no_range();
+ return range(
+ boost::next(p.data().begin(), 4 + senf::bytes(p->length()) ),
+ p.data().end() );
+}
+
+///////////////////////////////ct.e////////////////////////////////////////
+#undef prefix_
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
+// End:
namespace senf {
+ /** \brief xxx
+
+ \todo document me
+ \todo add usefull exceptions strings
+
+ */
struct UnsuportedTLVPacketException : public std::exception
{
virtual char const * what() const throw() {
}
};
+ /** \brief xxx
+ \todo document me
+ */
class Parse_TLVPacketLength
: public detail::packet::ParseIntOps<Parse_TLVPacketLength, boost::uint32_t>,
public PacketParserBase
Parse_TLVPacketLength(data_iterator i, state_type s) : PacketParserBase(i,s) {}
typedef boost::uint32_t value_type;
-
- value_type value() const;
+ static const size_type init_bytes = 1;
+ static value_type const min_value = 0;
+ static value_type const max_value = 4294967295u;
+ value_type value() const;
void value(value_type const & v);
Parse_TLVPacketLength const & operator= (value_type other);
-
- static const size_type init_bytes = 1;
-
+
size_type bytes() const;
void init() const;
/** \brief parse TLVPacket Packet
-
-
+ \todo document me
+
\see TLVPacketType
*/
+ template <class LengthParser>
struct Parse_TLVPacket : public PacketParserBase
{
# include SENF_PARSER()
SENF_PARSER_FIELD( type, Parse_UInt32 );
- SENF_PARSER_FIELD( length, Parse_TLVPacketLength );
+ SENF_PARSER_FIELD( length, LengthParser );
SENF_PARSER_FINALIZE(Parse_TLVPacket);
};
-
- /** \brief TLV Packet
- \image html TLV.png
+
+ /** \brief generic TLV Packet type
+
+ \todo document me
- \par Packet type (typedef):
- \ref TLVPacket
-
- \par Fields:
- \ref Parse_TLVPacket
-
\ingroup protocolbundle_mpegdvb
*/
+ template <class LengthParser>
struct TLVPacketType
: public PacketTypeBase
{
- typedef ConcretePacket<TLVPacketType> packet;
- typedef Parse_TLVPacket parser;
+ typedef ConcretePacket<TLVPacketType<LengthParser> > packet;
+ typedef Parse_TLVPacket<LengthParser> parser;
static optional_range nextPacketRange(packet p);
- static void init(packet p);
static size_type initSize();
+
static void finalize(packet p);
+
static void dump(packet p, std::ostream & os);
};
-
- typedef TLVPacketType::packet TLVPacket;
+
+ typedef TLVPacketType<Parse_TLVPacketLength>::packet TLVPacket;
+ typedef TLVPacketType<Parse_UInt8>::packet TLVFix8Packet;
+ typedef TLVPacketType<Parse_UInt16>::packet TLVFix16Packet;
+ typedef TLVPacketType<Parse_UInt24>::packet TLVFix24Packet;
+ typedef TLVPacketType<Parse_UInt32>::packet TLVFix32Packet;
}
///////////////////////////////hh.e////////////////////////////////////////
//#include "TLVPacket.cci"
-//#include "TLVPacket.ct"
+#include "TLVPacket.ct"
//#include "TLVPacket.cti"
#endif
#include "../../Utils/auto_unit_test.hh"
#include <boost/test/test_tools.hpp>
+#include <vector>
#define prefix_
///////////////////////////////cc.p////////////////////////////////////////
using namespace senf;
-BOOST_AUTO_UNIT_TEST(tlvPacket_static)
+
+template <class TLVPacketType>
+void check_TLVPacket(TLVPacketType tlvPacket, boost::uint32_t type, boost::uint32_t length)
+{
+ BOOST_CHECK_EQUAL( tlvPacket->type(), type );
+ BOOST_CHECK_EQUAL( tlvPacket->length(), length );
+
+ PacketData & tlvPacket_value (tlvPacket.next().data());
+ BOOST_CHECK_EQUAL( tlvPacket_value.size(), length);
+ for (int i=0, j=tlvPacket_value.size(); i<j; i++)
+ BOOST_CHECK_EQUAL( tlvPacket_value[i], i );
+}
+
+
+BOOST_AUTO_UNIT_TEST(TLVPacket_static)
{
// check static values:
// number of bytes to allocate for a new TLVPacket should be 5
- BOOST_CHECK_EQUAL( init_bytes<Parse_TLVPacket>::value, 5u );
- BOOST_CHECK_EQUAL( TLVPacketType::initSize(), 5u );
+ BOOST_CHECK_EQUAL( TLVPacket::type::initSize(), 5u );
}
-BOOST_AUTO_UNIT_TEST(tlvPacket_parse_packet_with_simple_length)
+BOOST_AUTO_UNIT_TEST(TLVPacket_parse_packet_with_simple_length)
{
unsigned char data[] = {
0x01, 0x23, 0x45, 0x67, // type
0x0A, // first bit not set, length=10
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09 // value (payload)
};
-
senf::TLVPacket tlvPacket (senf::TLVPacket::create(data));
-
- BOOST_CHECK_EQUAL( tlvPacket->type(), 0x01234567u );
- BOOST_CHECK_EQUAL( tlvPacket->length(), 0x0Au );
-
- PacketData & tlvPacket_value (tlvPacket.next().data());
- BOOST_CHECK_EQUAL( tlvPacket_value.size(), 0x0Au);
- for (int i=0, j=tlvPacket_value.size(); i<j; i++)
- BOOST_CHECK_EQUAL( tlvPacket_value[i], i );
+ check_TLVPacket( tlvPacket, 0x01234567u, 0x0Au );
}
-BOOST_AUTO_UNIT_TEST(tlvPacket_parse_packet_with_extended_length)
+BOOST_AUTO_UNIT_TEST(TLVPacket_parse_packet_with_extended_length)
{
unsigned char data[] = {
0x01, 0x23, 0x45, 0x67, // type
0x81, // first and last bit set => one byte length following
0x0A, // length (10 bytes value)
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09 // value (payload)
- };
-
+ };
senf::TLVPacket tlvPacket (senf::TLVPacket::create(data));
-
- BOOST_CHECK_EQUAL( tlvPacket->type(), 0x01234567u );
- BOOST_CHECK_EQUAL( tlvPacket->length(), 0x0Au );
-
- PacketData & tlvPacket_value (tlvPacket.next().data());
- BOOST_CHECK_EQUAL( tlvPacket_value.size(), 0x0Au);
- for (int i=0, j=tlvPacket_value.size(); i<j; i++)
- BOOST_CHECK_EQUAL( tlvPacket_value[i], i );
+ check_TLVPacket( tlvPacket, 0x01234567u, 0x0Au );
}
-BOOST_AUTO_UNIT_TEST(tlvPacket_create_packet_with_simple_length)
+BOOST_AUTO_UNIT_TEST(TLVPacket_create_packet_with_simple_length)
{
std::string payload ("Hello, world!");
TLVPacket tlvPacket (TLVPacket::create());
}
-BOOST_AUTO_UNIT_TEST(tlvPacket_create_packet_with_extended_length)
+BOOST_AUTO_UNIT_TEST(TLVPacket_create_packet_with_extended_length)
{
std::string payload (
"This is a very long string with more than 127 characters to check if the TLV-Packet "
BOOST_CHECK( equal( tlvPacket_value2.begin(), tlvPacket_value2.end(), payload.begin() ));
}
+BOOST_AUTO_UNIT_TEST(TLVPacket_create_invalid_packet)
+{
+
+}
+
+BOOST_AUTO_UNIT_TEST(TLVFixPacket_static)
+{
+ // check static values:
+ // number of bytes to allocate for a new TLVFixPacket should be 4+bytes_of_length
+ BOOST_CHECK_EQUAL( TLVFix8Packet::type::initSize(), 4+1u );
+ BOOST_CHECK_EQUAL( TLVFix16Packet::type::initSize(), 4+2u );
+ BOOST_CHECK_EQUAL( TLVFix24Packet::type::initSize(), 4+3u );
+ BOOST_CHECK_EQUAL( TLVFix32Packet::type::initSize(), 4+4u );
+}
+
+
+template <class TLVFixPacketType>
+void test_TLVFixPacket_parsing(unsigned lengthParser_size)
+{
+ std::vector<char> data;
+ data.push_back(0x01); data.push_back(0x23); data.push_back(0x45); data.push_back(0x67); // type
+ data.insert(data.end(), lengthParser_size-1, 0x00);
+ data.push_back(0x0A); // length
+ for( int i=0; i < 10; i++ ) {
+ data.push_back(i); // payload
+ }
+ TLVFixPacketType tlvPacket (TLVFixPacketType::create(
+ boost::make_iterator_range(data.begin(), data.end())));
+ check_TLVPacket( tlvPacket, 0x01234567u, 0x0Au );
+}
+
+BOOST_AUTO_UNIT_TEST(TLVFixPacket_parse_packet)
+{
+ test_TLVFixPacket_parsing<TLVFix8Packet>( Parse_UInt8::fixed_bytes);
+ test_TLVFixPacket_parsing<TLVFix16Packet>( Parse_UInt16::fixed_bytes);
+ test_TLVFixPacket_parsing<TLVFix24Packet>( Parse_UInt24::fixed_bytes);
+ test_TLVFixPacket_parsing<TLVFix32Packet>( Parse_UInt32::fixed_bytes);
+}
+
+
+template <class TLVFixPacketType>
+void test_TLVFixPacket_creating()
+{
+ std::string payload ("Hello, world!");
+ TLVFixPacketType tlvPacket (TLVFixPacketType::create());
+ tlvPacket->type() = 42u;
+ DataPacket::createAfter( tlvPacket, payload );
+ tlvPacket.finalize();
+
+ BOOST_CHECK_EQUAL( tlvPacket->type(), 42u);
+ BOOST_CHECK_EQUAL( tlvPacket->length(), 13u);
+
+ PacketData & tlvPacket_value (tlvPacket.next().data());
+ BOOST_CHECK( equal( tlvPacket_value.begin(), tlvPacket_value.end(), payload.begin() ));
+}
+
+BOOST_AUTO_UNIT_TEST(TLVFixPacket_create_packet)
+{
+ test_TLVFixPacket_creating<TLVFix8Packet>();
+ test_TLVFixPacket_creating<TLVFix16Packet>();
+ test_TLVFixPacket_creating<TLVFix24Packet>();
+ test_TLVFixPacket_creating<TLVFix32Packet>();
+}
+
+
+template <class TLVFixPacketType>
+void test_invalid_TLVFixPacket_creating(boost::uint32_t max_value)
+{
+ TLVFixPacketType tlvPacket (TLVFixPacketType::create());
+ tlvPacket->type() = 42u;
+ DataPacket payload (DataPacket::createAfter( tlvPacket, max_value+1));
+ //DataPacket::createAfter( payload, 1); // this is one byte to much.
+ BOOST_CHECK_THROW( tlvPacket.finalize(), UnsuportedTLVPacketException);
+}
+
+BOOST_AUTO_UNIT_TEST(TLVFixPacket_create_invalid_packet)
+{
+ test_invalid_TLVFixPacket_creating<TLVFix8Packet> ( Parse_UInt8::max_value);
+ test_invalid_TLVFixPacket_creating<TLVFix16Packet>( Parse_UInt16::max_value);
+ test_invalid_TLVFixPacket_creating<TLVFix24Packet>( Parse_UInt24::max_value);
+ //test_invalid_TLVFixPacket_creating<TLVFix32Packet>( Parse_UInt32::max_value);
+}
+
///////////////////////////////cc.e////////////////////////////////////////
#undef prefix_