senf/Packets/MPEGDVBBundle/GREPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Joachim Kaeber <jkaeber@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 GREPacket public header */
  25
  26 #ifndef HH_SENF_Packets_MPEGDVBBundle_GREPacket_
  27 #define HH_SENF_Packets_MPEGDVBBundle_GREPacket_ 1
  28
  29 // Custom includes
  30 #include <senf/Packets/DefaultBundle/EthernetPacket.hh>
  31
  32 //#include "GREPacket.mpp"
  33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  34
  35 namespace senf {
  36
  37     /** \brief Parse a GRE packet
  38
  39         Parser implementing the header of a General Routing Encapsulation (GRE, RFC 2784) Packet
  40
  41         \see GREPacketType
  42      */
  43     struct GREChecksumParser : public PacketParserBase {
  44 #       include SENF_PARSER()
  45         SENF_PARSER_FIELD ( checksum1_, UInt16Parser );
  46         SENF_PARSER_PRIVATE_FIELD ( reserved1_, UInt16Parser );
  47         SENF_PARSER_FINALIZE(GREChecksumParser);
  48     };
  49
  50     struct GREPacketParser : public PacketParserBase
  51     {
  52 #       include SENF_PARSER()
  53
  54         SENF_PARSER_BITFIELD         ( checksum_present,  1, bool );
  55         SENF_PARSER_PRIVATE_BITFIELD ( reserved0_,       12, unsigned ); // TODO: SKIP !!
  56         SENF_PARSER_BITFIELD         ( version_number,    3, unsigned ); // TODO: Always Zero !!
  57         SENF_PARSER_FIELD            ( protocol_type,    UInt16Parser );
  58         SENF_PARSER_PRIVATE_VARIANT  ( checksum_,  checksum_present,
  59                                                    (VoidPacketParser) (GREChecksumParser) );
  60
  61         SENF_PARSER_FINALIZE( GREPacketParser );
  62
  63       private:
  64         UInt16Parser checksum() const /// only defined if checksum_present() == \c true
  65              { return checksum_().get<1>().checksum1_(); }
  66     };
  67
  68     /** \brief GRE packet
  69
  70         \par Packet type (typedef):
  71             \ref GREPacket
  72
  73         \par Fields:
  74             \ref GREPacketParser
  75             \image html GREPacket.png
  76
  77         \ingroup protocolbundle_mpegdvb
  78      */
  79     struct GREPacketType
  80         : public PacketTypeBase,
  81           public PacketTypeMixin<GREPacketType, EtherTypes>
  82     {
  83         typedef PacketTypeMixin<GREPacketType, EtherTypes> mixin;
  84         typedef ConcretePacket<GREPacketType> packet;
  85         typedef GREPacketParser parser;
  86
  87         using mixin::nextPacketRange;
  88         using mixin::nextPacketType;
  89         using mixin::init;
  90         using mixin::initSize;
  91
  92         static void dump(packet p, std::ostream & os);
  93         static EtherTypes::key_t nextPacketKey(packet p) {
  94           return p->protocol_type();
  95         }
  96         static void finalize(packet p) {
  97           p->protocol_type() << key(p.next(nothrow));
  98           p->version_number() = 0; // as per RFC2784, 2.3.1
  99
 100           if (p->checksum_present()) {
 101             // compute checksum
 102           } else {
 103             // ???
 104           }
 105         }
 106     };
 107
 108     /** \brief GRE packet typedef */
 109     typedef GREPacketType::packet GREPacket;
 110
 111
 112 }
 113
 114
 115 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 116 //#include "TransportPacket.cci"
 117 //#include "TransportPacket.ct"
 118 //#include "TransportPacket.cti"
 119 #endif
 120
 121 \f
 122 // Local Variables:
 123 // mode: c++
 124 // fill-column: 100
 125 // c-file-style: "senf"
 126 // indent-tabs-mode: nil
 127 // ispell-local-dictionary: "american"
 128 // compile-command: "scons -u test"
 129 // comment-column: 40
 130 // End: