NEW FILE HEADER / COPYRIGHT FORMAT

[senf.git] / Packets / MPEGDVBBundle / TLVPacket.hh

diff --git a/Packets/MPEGDVBBundle/TLVPacket.hh b/Packets/MPEGDVBBundle/TLVPacket.hh
index 5f43f8b..4ba9b94 100644 (file)
--- a/Packets/MPEGDVBBundle/TLVPacket.hh
+++ b/Packets/MPEGDVBBundle/TLVPacket.hh
@@ -1,9 +1,9 @@
 // $Id$
 //
 // Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS) 
+// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+//     Thorsten Horstmann <tho@berlios.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
@@ -35,6 +35,12 @@
 
 namespace senf {
 
+    /** \brief xxx
+        
+        \todo document me
+        \todo add usefull exceptions strings
+         
+    */
     struct UnsuportedTLVPacketException : public std::exception
     { 
         virtual char const * what() const throw() { 
@@ -42,37 +48,40 @@ namespace senf {
         }
     };
 
-    class Parse_TLVPacketLength 
-        : public detail::packet::ParseIntOps<Parse_TLVPacketLength, boost::uint32_t>,
+    /** \brief xxx
+        \todo document me
+    */
+    class TLVPacketLengthParser 
+        : public detail::packet::IntParserOps<TLVPacketLengthParser, boost::uint32_t>,
           public PacketParserBase
     {
     public:
-        Parse_TLVPacketLength(data_iterator i, state_type s) : PacketParserBase(i,s) {}
+        TLVPacketLengthParser(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;
-
+        TLVPacketLengthParser const & operator= (value_type other);
+    
         size_type bytes() const;
             
         void init() const;
 
     private:
-        typedef Parse_Flag      <    0 > Parse_extended_length_flag;
-        typedef Parse_UIntField < 1, 8 > Parse_fixed_length;
+        typedef FlagParser      <    0 > ExtendedLengthFlagParser;
+        typedef UIntFieldParser < 1, 8 > FixedLengthParser;
 
-        Parse_extended_length_flag extended_length_flag() const {
-            return parse<Parse_extended_length_flag>( 0 );
+        ExtendedLengthFlagParser extended_length_flag() const {
+            return parse<ExtendedLengthFlagParser>( 0 );
         }
 
-        Parse_fixed_length fixed_length_field() const {
-            return parse<Parse_fixed_length>( 0 );
+        FixedLengthParser fixed_length_field() const {
+            return parse<FixedLengthParser>( 0 );
         }
         
         void resize(size_type size);
@@ -80,51 +89,55 @@ namespace senf {
         
     /** \brief parse TLVPacket Packet
     
-        XXX
-        
+        \todo document me
+     
         \see TLVPacketType
      */
-    struct Parse_TLVPacket : public PacketParserBase
+    template <class LengthParser>
+    struct TLVPacketParser : public PacketParserBase
     {
 #       include SENF_PARSER()
         
-        SENF_PARSE_FIELD( type,   Parse_UInt32 );
-        SENF_PARSE_FIELD( length, Parse_TLVPacketLength );
+        SENF_PARSER_FIELD( type,   UInt32Parser );
+        SENF_PARSER_FIELD( length, LengthParser );
         
-        SENF_PARSER_FINALIZE(Parse_TLVPacket);
+        SENF_PARSER_FINALIZE(TLVPacketParser);
     };
-
-    /** \brief TLV Packet
+    
+    /** \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;
-
+#ifndef DOXYGEN
+        typedef ConcretePacket<TLVPacketType<LengthParser> > packet;
+        typedef TLVPacketParser<LengthParser> parser;
+#endif
         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<TLVPacketLengthParser>::packet TLVPacket;
     
+    typedef ConcretePacket<TLVPacketType<UInt8Parser> >  TLVFix8Packet;
+    typedef ConcretePacket<TLVPacketType<UInt16Parser> > TLVFix16Packet;
+    typedef ConcretePacket<TLVPacketType<UInt24Parser> > TLVFix24Packet;
+    typedef ConcretePacket<TLVPacketType<UInt32Parser> > TLVFix32Packet;
 }
 
 
 ///////////////////////////////hh.e////////////////////////////////////////
 //#include "TLVPacket.cci"
-//#include "TLVPacket.ct"
+#include "TLVPacket.ct"
 //#include "TLVPacket.cti"
 #endif