senf/Packets/DefaultBundle/LlcSnapPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Thorsten Horstmann <tho@berlios.de>
  27
  28 /** \file
  29     \brief LLC/SNAP public header */
  30
  31 #ifndef HH_SENF_Packets_DefaultBundle_LlcSnapPacket_
  32 #define HH_SENF_Packets_DefaultBundle_LlcSnapPacket_ 1
  33
  34 // Custom includes
  35 #include "EthernetPacket.hh"
  36
  37 //#include "LlcSnapPacket.mpp"
  38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 namespace senf {
  41
  42     /** \brief Parse a LLC/SNAP header
  43
  44         \image html LlcSnapPacket.png
  45         \todo document me
  46      */
  47     struct LlcSnapPacketParser : public PacketParserBase
  48     {
  49 #       include SENF_FIXED_PARSER()
  50
  51         SENF_PARSER_FIELD( dsap, UInt8Parser );
  52         SENF_PARSER_FIELD( ssap, UInt8Parser );
  53         SENF_PARSER_FIELD( ctrl, UInt8Parser );
  54
  55         SENF_PARSER_FIELD( protocolId, UInt24Parser );
  56         SENF_PARSER_FIELD( type_length, UInt16Parser );
  57
  58         SENF_PARSER_FINALIZE(LlcSnapPacketParser);
  59
  60         SENF_PARSER_INIT() {
  61             dsap() = 0xaa;
  62             ssap() = 0xaa;
  63             ctrl() = 0x03;
  64             protocolId() = 0x000000;
  65         }
  66     };
  67
  68     /** \brief LLC/SNAP header
  69
  70         \todo document me
  71
  72         \par Packet type (typedef):
  73             \ref LlcSnapPacketType
  74
  75         \par Fields:
  76             \ref LlcSnapPacketParser
  77
  78         \par Associated registries:
  79             \ref EtherTypes
  80
  81         \par Finalize action:
  82             XXXX
  83
  84         \ingroup protocolbundle_default
  85      */
  86     struct LlcSnapPacketType
  87         : public PacketTypeBase,
  88           public PacketTypeMixin<LlcSnapPacketType, EtherTypes>
  89     {
  90 #ifndef DOXYGEN
  91         typedef PacketTypeMixin<LlcSnapPacketType, EtherTypes> mixin;
  92 #endif
  93         typedef ConcretePacket<LlcSnapPacketType> packet; ///< LLC/SNAP packet typedef
  94         typedef LlcSnapPacketParser parser;               ///< typedef to the parser of LLC/SNAP packet
  95
  96         using mixin::nextPacketRange;
  97         using mixin::initSize;
  98         using mixin::init;
  99
 100         static factory_t nextPacketType(packet p);
 101         /** \brief Dump given LlcSnapPacket in readable form to given output stream */
 102         static void dump(packet p, std::ostream & os);
 103         static void finalize(packet p);
 104     };
 105
 106     /** \brief LLC/SNAP packet typedef
 107         \ingroup protocolbundle_default
 108      */
 109     typedef ConcretePacket<LlcSnapPacketType> LlcSnapPacket;
 110 }
 111
 112
 113 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 114 //#include "LlcSnapPacket.cci"
 115 //#include "LlcSnapPacket.ct"
 116 //#include "LlcSnapPacket.cti"
 117 #endif
 118
 119 \f
 120 // Local Variables:
 121 // mode: c++
 122 // fill-column: 100
 123 // c-file-style: "senf"
 124 // indent-tabs-mode: nil
 125 // ispell-local-dictionary: "american"
 126 // compile-command: "scons -u test"
 127 // comment-column: 40
 128 // End: