removed some useless spaces; not very important, I know :)

[senf.git] / Packets / DefaultBundle / EthernetPacket.hh

diff --git a/Packets/DefaultBundle/EthernetPacket.hh b/Packets/DefaultBundle/EthernetPacket.hh
index 359f05d..aadcdde 100644 (file)
--- 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
@@ -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,26 +66,15 @@ namespace senf {
 
         \see EthernetPacketType
      */
-    struct Parse_Ethernet : public PacketParserBase
+    struct EthernetPacketParser : public PacketParserBase
     {
-        typedef Parse_UInt16                      Parse_Type;
+#       include SENF_FIXED_PARSER()
 
-#       ifndef DOXYGEN
+        SENF_PARSER_FIELD( destination, MACAddressParser    );
+        SENF_PARSER_FIELD( source,      MACAddressParser    );
+        SENF_PARSER_FIELD( type_length, UInt16Parser );
 
-        SENF_PACKET_PARSER_INIT(Parse_Ethernet);
-
-        SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((Field)( destination, Parse_MAC  ))
-            ((Field)( source,      Parse_MAC  ))
-            ((Field)( type,        Parse_Type )) );
-
-#       else
-
-        Parse_MAC destination();
-        Parse_MAC source();
-        Parse_Type type();
-
-#       endif
+        SENF_PARSER_FINALIZE(EthernetPacketParser);
     };
 
     /** \brief EtherType registry
@@ -106,37 +95,36 @@ namespace senf {
             \ref EthernetPacket
 
         \par Fields:
-            \ref Parse_Ethernet
+            \ref EthernetPacketParser
 
         \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;
         typedef ConcretePacket<EthernetPacketType> packet;
-        typedef Parse_Ethernet parser;
-
+        typedef EthernetPacketParser parser;
+#endif
         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 factory_t nextPacketType(packet p);
         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
         
@@ -144,31 +132,17 @@ namespace senf {
 
         \see EthVLanPacketType
      */
-    struct Parse_EthVLan : public PacketParserBase
+    struct EthVLanPacketParser : public PacketParserBase
     {
-        typedef Parse_UIntField < 0,  3 > Parse_Priority;
-        typedef Parse_Flag          < 3 > Parse_CFI;
-        typedef Parse_UIntField < 4, 16 > Parse_VLanId;
-        typedef Parse_UInt16              Parse_Type;
-
-#       ifndef DOXYGEN
-
-        SENF_PACKET_PARSER_INIT(Parse_EthVLan);
-
-        SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((OverlayField)( priority, Parse_Priority ))
-            ((OverlayField)( cfi,      Parse_CFI      ))
-            ((Field       )( vlanId,   Parse_VLanId   ))
-            ((Field       )( type,     Parse_Type     )) );
+#       include SENF_FIXED_PARSER()
 
-#       else
+        SENF_PARSER_BITFIELD( priority,  3, unsigned );
+        SENF_PARSER_BITFIELD( cfi,       1, bool     );
+        SENF_PARSER_BITFIELD( vlanId,   12, unsigned );
 
-        Parse_Priority priority();
-        Parse_CFI cfi();
-        Parse_VLanId vlanId();
-        Parse_Type type();
+        SENF_PARSER_FIELD( type, UInt16Parser );
 
-#       endif
+        SENF_PARSER_FINALIZE(EthVLanPacketParser);
     };
 
     /** \brief Ethernet VLAN tag
@@ -177,21 +151,25 @@ namespace senf {
             \ref EthVLanPacket
 
         \par Fields:
-            \ref Parse_EthVLan
+            \ref EthVLanPacketParser
 
         \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;
         typedef ConcretePacket<EthVLanPacketType> packet;
-        typedef Parse_EthVLan parser;
-
+        typedef EthVLanPacketParser parser;
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -199,7 +177,7 @@ 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(); }
 
         static void dump(packet p, std::ostream & os);
@@ -207,9 +185,9 @@ namespace senf {
     };
 
     /** \brief Ethernet VLAN tag typedef */
-    typedef EthVLanPacketType::packet EthVLanPacket;
-}
+    typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
 
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #endif