X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FDefaultBundle%2FEthernetPacket.hh;h=51a2389e2774e8b18397f248746025871897c285;hb=8674fb1d184e7d620eb7c604957b5b4203df37a6;hp=04516dbcccf7072c685614535f8630d977623f88;hpb=54eed72c506b09ef5b4be0b62fecedfbc0e3f261;p=senf.git

diff --git a/Packets/DefaultBundle/EthernetPacket.hh b/Packets/DefaultBundle/EthernetPacket.hh
index 04516db..51a2389 100644
--- a/Packets/DefaultBundle/EthernetPacket.hh
+++ b/Packets/DefaultBundle/EthernetPacket.hh
@@ -1,9 +1,9 @@
-// $id: EthernetPacket.hh 299 2007-07-10 21:23:49Z g0dil $
+// $Id$
 //
 // Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Thorsten Horstmann <tho@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -23,8 +23,8 @@
 /** \file
     \brief EthernetPacket public header */
 
-#ifndef HH_EthernetPacket_
-#define HH_EthernetPacket_ 1
+#ifndef HH_SENF_Packets_DefaultBundle_EthernetPacket_
+#define HH_SENF_Packets_DefaultBundle_EthernetPacket_ 1
 
 // Custom includes
 #include <algorithm>
@@ -43,9 +43,9 @@ namespace senf {
         \see MACAddress \n
             EthernetPacket
      */
-    struct Parse_MAC : public PacketParserBase
+    struct MACAddressParser : public PacketParserBase
     {
-        Parse_MAC(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
+        MACAddressParser(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
        
         ///////////////////////////////////////////////////////////////////////////
 
@@ -57,7 +57,7 @@ namespace senf {
         operator value_type () { return value(); }
         byte & operator[](size_type index) { return *boost::next(i(),index);  }
 
-        Parse_MAC const & operator= (value_type const & other) { value(other); return *this; }
+        MACAddressParser const & operator= (value_type const & other) { value(other); return *this; }
     };
     
     /** \brief Parse an Ethernet packet
@@ -66,15 +66,15 @@ namespace senf {
 
         \see EthernetPacketType
      */
-    struct Parse_Ethernet : public PacketParserBase
+    struct EthernetPacketParser : public PacketParserBase
     {
 #       include SENF_FIXED_PARSER()
 
-        SENF_PARSE_FIELD( destination, Parse_MAC    );
-        SENF_PARSE_FIELD( source,      Parse_MAC    );
-        SENF_PARSE_FIELD( type,        Parse_UInt16 );
+        SENF_PARSER_FIELD( destination, MACAddressParser    );
+        SENF_PARSER_FIELD( source,      MACAddressParser    );
+        SENF_PARSER_FIELD( type_length, UInt16Parser );
 
-        SENF_PARSER_FINALIZE(Parse_Ethernet);
+        SENF_PARSER_FINALIZE(EthernetPacketParser);
     };
 
     /** \brief EtherType registry
@@ -85,7 +85,6 @@ namespace senf {
             \ref PacketRegistry
      */
     struct EtherTypes {
-        // See 
         typedef boost::uint16_t key_t;
     };
 
@@ -95,37 +94,39 @@ namespace senf {
             \ref EthernetPacket
 
         \par Fields:
-            \ref Parse_Ethernet
+            \ref EthernetPacketParser
+            \image html EthernetPacket.png
 
         \par Associated registries:
             \ref EtherTypes
 
+        \par Finalize action:
+            Set \a type from type of next packet if found in \ref EtherTypes
+
         \ingroup protocolbundle_default
      */
     struct EthernetPacketType
         : public PacketTypeBase,
           public PacketTypeMixin<EthernetPacketType, EtherTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<EthernetPacketType, EtherTypes> mixin;
+#endif
         typedef ConcretePacket<EthernetPacketType> packet;
-        typedef Parse_Ethernet parser;
+        typedef EthernetPacketParser parser;
 
         using mixin::nextPacketRange;
-        using mixin::nextPacketType;
         using mixin::initSize;
         using mixin::init;
 
-        /** \todo Add LLC/SNAP support -> only use the registry
-            for type() values >=1536, otherwise expect an LLC header */
-        static registry_key_t nextPacketKey(packet p) 
-            { return p->type(); }
-
-        static void dump(packet p, std::ostream & os);
+        static factory_t nextPacketType(packet p);
+        /// Dump given EthernetPacket in readable form to given output stream
+        static void dump(packet p, std::ostream & os); 
         static void finalize(packet p);
     };
 
     /** \brief Ethernet packet typedef */
-    typedef EthernetPacketType::packet EthernetPacket;
+    typedef ConcretePacket<EthernetPacketType> EthernetPacket;
 
     /** \brief Parse an ethernet VLAN tag
         
@@ -133,17 +134,17 @@ namespace senf {
 
         \see EthVLanPacketType
      */
-    struct Parse_EthVLan : public PacketParserBase
+    struct EthVLanPacketParser : public PacketParserBase
     {
 #       include SENF_FIXED_PARSER()
 
-        SENF_PARSE_BITFIELD( priority,  3, unsigned );
-        SENF_PARSE_BITFIELD( cfi,       1, bool     );
-        SENF_PARSE_BITFIELD( vlanId,   12, unsigned );
+        SENF_PARSER_BITFIELD( priority,  3, unsigned );
+        SENF_PARSER_BITFIELD( cfi,       1, bool     );
+        SENF_PARSER_BITFIELD( vlanId,   12, unsigned );
 
-        SENF_PARSE_FIELD( type, Parse_UInt16 );
+        SENF_PARSER_FIELD( type, UInt16Parser );
 
-        SENF_PARSER_FINALIZE(Parse_EthVLan);
+        SENF_PARSER_FINALIZE(EthVLanPacketParser);
     };
 
     /** \brief Ethernet VLAN tag
@@ -152,20 +153,26 @@ namespace senf {
             \ref EthVLanPacket
 
         \par Fields:
-            \ref Parse_EthVLan
-
+            \ref EthVLanPacketParser
+            \image html EthVLanPacket.png
+        
         \par Associated registries:
             \ref EtherTypes
 
+        \par Finalize action:
+            Set \a type from type of next packet if found in \ref EtherTypes
+
         \ingroup protocolbundle_default
      */
     struct EthVLanPacketType
         : public PacketTypeBase, 
           public PacketTypeMixin<EthVLanPacketType, EtherTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
+#endif
         typedef ConcretePacket<EthVLanPacketType> packet;
-        typedef Parse_EthVLan parser;
+        typedef EthVLanPacketParser parser;
 
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
@@ -174,21 +181,20 @@ namespace senf {
 
         /** \todo Add LLC/SNAP support -> only use the registry
             for type() values >=1536, otherwise expect an LLC header */
-        static registry_key_t nextPacketKey(packet p) 
+        static key_t nextPacketKey(packet p) 
             { return p->type(); }
 
+        /// Dump given EthVLanPacket in readable form to given output stream
         static void dump(packet p, std::ostream & os);
         static void finalize(packet p);
     };
 
     /** \brief Ethernet VLAN tag typedef */
-    typedef EthVLanPacketType::packet EthVLanPacket;
-}
+    typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
 
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
-#endif
-#ifndef SENF_PACKETS_DECL_ONLY
 //#include "EthernetPacket.cci"
 //#include "EthernetPacket.ct"
 //#include "EthernetPacket.cti"