TLVPacket creating is working now; thanx to Stefan once again. Documentation will...
[senf.git] / Packets / MPEGDVBBundle / TLVPacket.hh
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.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 TLVPacket public header */
25
26 #ifndef HH_TLVPacket_
27 #define HH_TLVPacket_ 1
28
29 // Custom includes
30 #include <algorithm>
31 #include "../../Packets/PacketType.hh"
32 #include "../../Packets/ParseInt.hh"
33 #include "../../Packets/PacketParser.hh"
34
35 //#include "TLVPacket.mpp"
36 ///////////////////////////////hh.p////////////////////////////////////////
37
38 namespace senf {
39
40     struct UnsuportedTLVPacketException : public std::exception
41     { 
42         virtual char const * what() const throw() { 
43             return "length of length can be max. 4 bytes. Sorry.";
44         }
45     };
46
47     class Parse_TLVPacketLength 
48         : public detail::packet::ParseIntOps<Parse_TLVPacketLength, boost::uint32_t>,
49           public PacketParserBase
50     {
51     public:
52 #       ifndef DOXYGEN
53         
54         SENF_PACKET_PARSER_NO_INIT(Parse_TLVPacketLength);
55
56 #       endif
57
58         typedef boost::uint32_t value_type;
59     
60         value_type value() const;
61
62         void value(value_type const & v);
63         
64         Parse_TLVPacketLength const & operator= (value_type other);
65             
66         static const size_type init_bytes = 1;
67
68         size_type bytes() const;
69             
70         void init() const;
71
72     private:
73         typedef Parse_Flag      <    0 > Parse_extended_length_flag;
74         typedef Parse_UIntField < 1, 8 > Parse_fixed_length;
75
76         Parse_extended_length_flag extended_length_flag() const {
77             return parse<Parse_extended_length_flag>( 0 );
78         }
79
80         Parse_fixed_length fixed_length_field() const {
81             return parse<Parse_fixed_length>( 0 );
82         }
83         
84         void resize(size_type size);
85     };  
86         
87     /** \brief parse TLVPacket Packet
88     
89         XXX
90         
91         \see TLVPacketType
92      */
93     struct Parse_TLVPacket : public PacketParserBase
94     {
95 #       ifndef DOXYGEN
96         
97         SENF_PACKET_PARSER_INIT(Parse_TLVPacket);
98         
99         SENF_PACKET_PARSER_DEFINE_FIELDS(
100             ((Field)( type,   Parse_UInt32          ))
101             ((Field)( length, Parse_TLVPacketLength ))
102         );
103         
104 #       endif
105     };
106
107     /** \brief TLV Packet
108         
109         \par Packet type (typedef):
110             \ref TLVPacket
111
112         \par Fields:
113             \ref Parse_TLVPacket
114
115         \ingroup protocolbundle_mpegdvb
116      */
117     struct TLVPacketType
118         : public PacketTypeBase
119     {
120         typedef ConcretePacket<TLVPacketType> packet;
121         typedef Parse_TLVPacket parser;
122
123         static optional_range nextPacketRange(packet p);
124         static void init(packet p);
125         static size_type initSize();
126         static void finalize(packet p);
127         static void dump(packet p, std::ostream & os);
128     };
129         
130     typedef TLVPacketType::packet TLVPacket;
131     
132 }
133
134
135 ///////////////////////////////hh.e////////////////////////////////////////
136 //#include "TLVPacket.cci"
137 //#include "TLVPacket.ct"
138 //#include "TLVPacket.cti"
139 #endif
140
141 \f
142 // Local Variables:
143 // mode: c++
144 // fill-column: 100
145 // c-file-style: "senf"
146 // indent-tabs-mode: nil
147 // ispell-local-dictionary: "american"
148 // compile-command: "scons -u test"
149 // comment-column: 40
150 // End: