Packets: Add packet diagrams

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

diff --git a/Packets/DefaultBundle/EthernetPacket.hh b/Packets/DefaultBundle/EthernetPacket.hh
index 635f43b..8286e88 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)
-//     Thorsten Horstmann <thorsten.horstmann@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_PARSER_FIELD( destination, Parse_MAC    );
-        SENF_PARSER_FIELD( source,      Parse_MAC    );
-        SENF_PARSER_FIELD( type_length, 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
@@ -95,7 +95,8 @@ namespace senf {
             \ref EthernetPacket
 
         \par Fields:
-            \ref Parse_Ethernet
+            \ref EthernetPacketParser
+            \image html EthernetPacket.png
 
         \par Associated registries:
             \ref EtherTypes
@@ -109,11 +110,10 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<EthernetPacketType, EtherTypes>
     {
-#ifndef DOXYGEN
         typedef PacketTypeMixin<EthernetPacketType, EtherTypes> mixin;
         typedef ConcretePacket<EthernetPacketType> packet;
-        typedef Parse_Ethernet parser;
-#endif
+        typedef EthernetPacketParser parser;
+
         using mixin::nextPacketRange;
         using mixin::initSize;
         using mixin::init;
@@ -132,7 +132,7 @@ namespace senf {
 
         \see EthVLanPacketType
      */
-    struct Parse_EthVLan : public PacketParserBase
+    struct EthVLanPacketParser : public PacketParserBase
     {
 #       include SENF_FIXED_PARSER()
 
@@ -140,9 +140,9 @@ namespace senf {
         SENF_PARSER_BITFIELD( cfi,       1, bool     );
         SENF_PARSER_BITFIELD( vlanId,   12, unsigned );
 
-        SENF_PARSER_FIELD( type, Parse_UInt16 );
+        SENF_PARSER_FIELD( type, UInt16Parser );
 
-        SENF_PARSER_FINALIZE(Parse_EthVLan);
+        SENF_PARSER_FINALIZE(EthVLanPacketParser);
     };
 
     /** \brief Ethernet VLAN tag
@@ -151,8 +151,9 @@ namespace senf {
             \ref EthVLanPacket
 
         \par Fields:
-            \ref Parse_EthVLan
-
+            \ref EthVLanPacketParser
+            \image html EthVLanPacket.png
+        
         \par Associated registries:
             \ref EtherTypes
 
@@ -165,11 +166,10 @@ namespace senf {
         : public PacketTypeBase, 
           public PacketTypeMixin<EthVLanPacketType, EtherTypes>
     {
-#ifndef DOXYGEN
         typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
         typedef ConcretePacket<EthVLanPacketType> packet;
-        typedef Parse_EthVLan parser;
-#endif
+        typedef EthVLanPacketParser parser;
+
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -177,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);