Packets/MPEGDVBBundle/GREPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Joachim Kaeber <joachim.kaeber@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 GREPacket public header */
  25
  26 #ifndef HH_GREPacket
  27 #define HH_GREPacket 1
  28
  29 // Custom includes
  30 #include <algorithm>
  31 #include "../../Packets/Packets.hh"
  32
  33 //#include "GREPacket.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /** \brief Parse a GRE packet
  39
  40         Parser implementing the header of a General Routing Encapsulation (GRE, RFC 2784) Packet
  41
  42         \see GREPacketType
  43      */
  44     struct GREChecksumParser : public PacketParserBase {
  45 #       include SENF_PARSER()
  46         SENF_PARSER_PRIVATE_FIELD ( checksum1_,         Parse_UInt16 );
  47         SENF_PARSER_PRIVATE_FIELD ( reserved1_, Parse_UInt16 );
  48         SENF_PARSER_FINALIZE(GREChecksumParser);
  49     };
  50
  51     struct Parse_GREPacket : public PacketParserBase
  52     {
  53 #       include SENF_PARSER()
  54
  55         SENF_PARSER_BITFIELD         ( checksum_present,  1, bool );
  56         SENF_PARSER_PRIVATE_BITFIELD ( reserved0_,       12, unsigned ); // TODO: SKIP !!
  57         SENF_PARSER_BITFIELD_RO      ( version_number,    3, unsigned ); // TODO: Always Zero !!
  58         SENF_PARSER_FIELD            ( protocol_type,    Parse_UInt16 );
  59         SENF_PARSER_PRIVATE_VARIANT  ( checksum_,  checksum_present,
  60                                                    (VoidPacketParser) (GREChecksumParser) );
  61
  62         SENF_PARSER_FINALIZE( Parse_GREPacket );
  63
  64       private:
  65         Parse_UInt16 checksum() const /// only defined if checksum_present() == \c true
  66              { return checksum_().get<1>(); }
  67     };
  68
  69     /** \brief GRE packet
  70
  71         \par Packet type (typedef):
  72             \ref GREPacket
  73
  74         \par Fields:
  75             \ref Parse_GREPacket
  76
  77         \ingroup protocolbundle_mpegdvb
  78      */
  79     struct GREPacketType
  80         : public PacketTypeBase,
  81           public PacketTypeMixin<GREPacketType>
  82     {
  83         typedef PacketTypeMixin<GREPacketType> mixin;
  84         typedef ConcretePacket<GREPacketType> packet;
  85         typedef Parse_GREPacket parser;
  86
  87         using mixin::nextPacketRange;
  88         using mixin::init;
  89         using mixin::initSize;
  90
  91         static void dump(packet p, std::ostream & os);
  92     };
  93
  94     /** \brief GRE packet typedef */
  95     typedef GREPacketType::packet GREPacket;
  96
  97
  98 }
  99
 100
 101 ///////////////////////////////hh.e////////////////////////////////////////
 102 //#include "TransportPacket.cci"
 103 //#include "TransportPacket.ct"
 104 //#include "TransportPacket.cti"
 105 #endif
 106
 107 \f
 108 // Local Variables:
 109 // mode: c++
 110 // fill-column: 100
 111 // c-file-style: "senf"
 112 // indent-tabs-mode: nil
 113 // ispell-local-dictionary: "american"
 114 // compile-command: "scons -u test"
 115 // comment-column: 40
 116 // End: