Packets: Add MPLSPacket image
[senf.git] / Packets / DefaultBundle / MPLSPacket.hh
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Christian Niephaus <cni@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 MPLSPacket public header */
25
26 #ifndef HH_SENF_Packets_DefaultBundle_MPLSPacket_
27 #define HH_SENF_Packets_DefaultBundle_MPLSPacket_ 1
28
29 // Custom includes
30
31 #include "../../Packets/Packets.hh"
32
33 //#include "MPLSPacket.mpp"
34 ///////////////////////////////hh.p////////////////////////////////////////
35
36 namespace senf {
37
38     /** \brief Parse an MPLS packet
39
40         Parser implementing an MPLS header.
41
42         \image html MPLSPacket.png
43
44         \see MPLSPacketType
45      */
46     struct MPLSPacketParser : public PacketParserBase
47     {
48 #       include SENF_FIXED_PARSER()
49
50         SENF_PARSER_BITFIELD( label, 20, unsigned);
51         SENF_PARSER_BITFIELD( tc, 3, unsigned);
52         SENF_PARSER_BITFIELD( s, 1, bool);
53         SENF_PARSER_FIELD( ttl, UInt8Parser);
54
55         SENF_PARSER_FINALIZE(MPLSPacketParser);
56     };
57
58     /** \brief MPLS packet
59
60         \par Packet type (typedef):
61             \ref MPLSPacket
62
63         \par Fields:
64             \ref MPLSPacketParser
65           
66
67         \ingroup protocolbundle_default
68      */
69     struct MPLSPacketType
70         : public PacketTypeBase,
71           public PacketTypeMixin<MPLSPacketType>
72     {
73 #ifndef DOXYGEN
74         typedef PacketTypeMixin<MPLSPacketType> mixin;
75 #endif
76         typedef ConcretePacket<MPLSPacketType> packet;
77         typedef MPLSPacketParser parser;
78
79         using mixin::nextPacketRange;
80         using mixin::initSize;
81         using mixin::init;
82
83         static factory_t nextPacketType(packet p);
84         /// Dump given MPLSPacket in readable form to given output stream
85         static void dump(packet p, std::ostream & os); 
86         static void finalize(packet p);
87     };
88
89     /** \brief MPLS packet typedef */
90     typedef ConcretePacket<MPLSPacketType> MPLSPacket;
91
92
93 }
94
95 ///////////////////////////////hh.e////////////////////////////////////////
96 #endif
97 #ifndef SENF_PACKETS_DECL_ONLY
98 //#include "MPLSPacket.cci"
99 //#include "MPLSPacket.ct"
100 //#include "MPLSPacket.cti"
101 #endif
102
103 \f
104 // Local Variables:
105 // mode: c++
106 // fill-column: 100
107 // c-file-style: "senf"
108 // indent-tabs-mode: nil
109 // ispell-local-dictionary: "american"
110 // compile-command: "scons -u test"
111 // comment-column: 40
112 // End: