Packets/DefaultBundle: Document finalize() action

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

diff --git a/Packets/DefaultBundle/EthernetPacket.hh b/Packets/DefaultBundle/EthernetPacket.hh
index 2bc9fb6..f7d8e6d 100644 (file)
--- a/Packets/DefaultBundle/EthernetPacket.hh
+++ b/Packets/DefaultBundle/EthernetPacket.hh
@@ -20,36 +20,22 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief EthernetPacket public header */
+
 #ifndef HH_EthernetPacket_
 #define HH_EthernetPacket_ 1
 
 // Custom includes
 #include <algorithm>
-#include <boost/array.hpp>
-#include "Packets/Packets.hh"
+#include "../../Socket/Protocols/Raw/MACAddress.hh"
+#include "../../Packets/Packets.hh"
 
 //#include "EthernetPacket.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
 
-    /** \brief Ethernet MAC address
-        
-        The Ethernet MAC is modelled as a fixed-size container/sequence of 6 bytes.
-
-        \todo Move to someplace else when implementing the addressing classes
-     */
-    struct MACAddress
-        : boost::array<PacketParserBase::byte,6>
-    {
-        MACAddress(std::string addr);
-        template <class InputIterator>
-        MACAddress(InputIterator i);
-
-        struct SyntaxException : public std::exception
-        { virtual char const * what() const throw() { return "invalid mac address syntax"; } };
-    };
-
     /** \brief Parse an Ethernet MAC address 
 
         The ethernet MAC is returned by value as a 6-byte sequence
@@ -66,7 +52,7 @@ namespace senf {
         typedef MACAddress value_type;
         static const size_type fixed_bytes = 6u;
 
-        value_type value() const { return MACAddress(i()); }
+        value_type value() const { return MACAddress::from_data(i()); }
         void value(value_type const & v) { std::copy(v.begin(), v.end(), i()); }
         operator value_type () { return value(); }
         byte & operator[](size_type index) { return *boost::next(i(),index);  }
@@ -82,24 +68,13 @@ namespace senf {
      */
     struct Parse_Ethernet : public PacketParserBase
     {
-        typedef Parse_UInt16                      Parse_Type;
-
-#       ifndef DOXYGEN
+#       include SENF_FIXED_PARSER()
 
-        SENF_PACKET_PARSER_INIT(Parse_Ethernet);
+        SENF_PARSER_FIELD( destination, Parse_MAC    );
+        SENF_PARSER_FIELD( source,      Parse_MAC    );
+        SENF_PARSER_FIELD( type,        Parse_UInt16 );
 
-        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(Parse_Ethernet);
     };
 
     /** \brief EtherType registry
@@ -125,6 +100,9 @@ namespace senf {
         \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
@@ -146,6 +124,7 @@ namespace senf {
             { return p->type(); }
 
         static void dump(packet p, std::ostream & os);
+        static void finalize(packet p);
     };
 
     /** \brief Ethernet packet typedef */
@@ -159,29 +138,15 @@ namespace senf {
      */
     struct Parse_EthVLan : 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;
+#       include SENF_FIXED_PARSER()
 
-#       ifndef DOXYGEN
+        SENF_PARSER_BITFIELD( priority,  3, unsigned );
+        SENF_PARSER_BITFIELD( cfi,       1, bool     );
+        SENF_PARSER_BITFIELD( vlanId,   12, unsigned );
 
-        SENF_PACKET_PARSER_INIT(Parse_EthVLan);
+        SENF_PARSER_FIELD( type, Parse_UInt16 );
 
-        SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((OverlayField)( priority, Parse_Priority ))
-            ((OverlayField)( cfi,      Parse_CFI      ))
-            ((Field       )( vlanId,   Parse_VLanId   ))
-            ((Field       )( type,     Parse_Type     )) );
-
-#       else
-
-        Parse_Priority priority();
-        Parse_CFI cfi();
-        Parse_VLanId vlanId();
-        Parse_Type type();
-
-#       endif
+        SENF_PARSER_FINALIZE(Parse_EthVLan);
     };
 
     /** \brief Ethernet VLAN tag
@@ -195,6 +160,9 @@ namespace senf {
         \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
@@ -216,6 +184,7 @@ namespace senf {
             { return p->type(); }
 
         static void dump(packet p, std::ostream & os);
+        static void finalize(packet p);
     };
 
     /** \brief Ethernet VLAN tag typedef */
@@ -227,7 +196,7 @@ namespace senf {
 #endif
 #ifndef SENF_PACKETS_DECL_ONLY
 //#include "EthernetPacket.cci"
-#include "EthernetPacket.ct"
+//#include "EthernetPacket.ct"
 //#include "EthernetPacket.cti"
 #endif