senf/Packets/DefaultBundle/LlcSnapPacket.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 //     Thorsten Horstmann <tho@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 LLC/SNAP public header */
  25
  26 #ifndef HH_SENF_Packets_DefaultBundle_LlcSnapPacket_
  27 #define HH_SENF_Packets_DefaultBundle_LlcSnapPacket_ 1
  28
  29 // Custom includes
  30 #include "EthernetPacket.hh"
  31
  32 //#include "LlcSnapPacket.mpp"
  33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  34
  35 namespace senf {
  36
  37     /** \brief Parse a LLC/SNAP header
  38
  39         \image html LlcSnapPacket.png
  40         \todo document me
  41      */
  42     struct LlcSnapPacketParser : public PacketParserBase
  43     {
  44 #       include SENF_FIXED_PARSER()
  45
  46         SENF_PARSER_FIELD( dsap, UInt8Parser );
  47         SENF_PARSER_FIELD( ssap, UInt8Parser );
  48         SENF_PARSER_FIELD( ctrl, UInt8Parser );
  49
  50         SENF_PARSER_FIELD( protocolId, UInt24Parser );
  51         SENF_PARSER_FIELD( type_length, UInt16Parser );
  52
  53         SENF_PARSER_FINALIZE(LlcSnapPacketParser);
  54
  55         SENF_PARSER_INIT() {
  56             dsap() = 0xaa;
  57             ssap() = 0xaa;
  58             ctrl() = 0x03;
  59             protocolId() = 0x000000;
  60         }
  61     };
  62
  63     /** \brief LLC/SNAP header
  64
  65         \todo document me
  66
  67         \par Packet type (typedef):
  68             \ref LlcSnapPacketType
  69
  70         \par Fields:
  71             \ref LlcSnapPacketParser
  72
  73         \par Associated registries:
  74             \ref EtherTypes
  75
  76         \par Finalize action:
  77             XXXX
  78
  79         \ingroup protocolbundle_default
  80      */
  81     struct LlcSnapPacketType
  82         : public PacketTypeBase,
  83           public PacketTypeMixin<LlcSnapPacketType, EtherTypes>
  84     {
  85 #ifndef DOXYGEN
  86         typedef PacketTypeMixin<LlcSnapPacketType, EtherTypes> mixin;
  87 #endif
  88         typedef ConcretePacket<LlcSnapPacketType> packet; ///< LLC/SNAP packet typedef
  89         typedef LlcSnapPacketParser parser;               ///< typedef to the parser of LLC/SNAP packet
  90
  91         using mixin::nextPacketRange;
  92         using mixin::initSize;
  93         using mixin::init;
  94
  95         static factory_t nextPacketType(packet p);
  96         /** \brief Dump given LlcSnapPacket in readable form to given output stream */
  97         static void dump(packet p, std::ostream & os);
  98         static void finalize(packet p);
  99     };
 100
 101     /** \brief LLC/SNAP packet typedef
 102         \ingroup protocolbundle_default
 103      */
 104     typedef ConcretePacket<LlcSnapPacketType> LlcSnapPacket;
 105 }
 106
 107
 108 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 109 //#include "LlcSnapPacket.cci"
 110 //#include "LlcSnapPacket.ct"
 111 //#include "LlcSnapPacket.cti"
 112 #endif
 113
 114 \f
 115 // Local Variables:
 116 // mode: c++
 117 // fill-column: 100
 118 // c-file-style: "senf"
 119 // indent-tabs-mode: nil
 120 // ispell-local-dictionary: "american"
 121 // compile-command: "scons -u test"
 122 // comment-column: 40
 123 // End: