Packets: Add packet diagrams

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

diff --git a/Packets/DefaultBundle/UDPPacket.hh b/Packets/DefaultBundle/UDPPacket.hh
index 615c530..fb71f44 100644 (file)
--- a/Packets/DefaultBundle/UDPPacket.hh
+++ b/Packets/DefaultBundle/UDPPacket.hh
@@ -1,9 +1,9 @@
 // $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
+//     Stefan Bund <g0dil@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
@@ -20,11 +20,14 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-#ifndef HH_UDPPacket_
-#define HH_UDPPacket_ 1
+/** \file
+    \brief UDPPacket public header */
+
+#ifndef HH_SENF_Packets_DefaultBundle_UDPPacket_
+#define HH_SENF_Packets_DefaultBundle_UDPPacket_ 1
 
 // Custom includes
-#include "Packets/Packets.hh"
+#include "../../Packets/Packets.hh"
 
 //#include "UDPPacket.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -35,30 +38,25 @@ namespace senf {
 
         Parser implementing the UDP header. The fields implemented are:
 
-        <table class="senf">
-            <tr><th>Field name</th><th>Parser type</th></tr>
-            <tr><td>source</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>destination</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>length</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>crc</td><td>\ref Parse_16bit</td></tr>
-        </table>
-
-        \see UDPPacketType
+        \see UDPPacketType \n
             <a href="http://tools.ietf.org/html/rfc768">RFC 768</a>
      */
-    struct Parse_UDP : public PacketParserBase
+    struct UDPPacketParser : public PacketParserBase
     {
-        SENF_PACKET_PARSER_INIT(Parse_UDP);
+#       include SENF_FIXED_PARSER()
 
-        ///////////////////////////////////////////////////////////////////////////
+        SENF_PARSER_FIELD( source,      senf::UInt16Parser );
+        SENF_PARSER_FIELD( destination, senf::UInt16Parser );
+        SENF_PARSER_FIELD( length,      senf::UInt16Parser );
+        SENF_PARSER_FIELD( checksum,    senf::UInt16Parser );
 
-        typedef Parse_UInt16 Parse_16bit;
+        SENF_PARSER_FINALIZE(UDPPacketParser);
 
-        SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((Field)( source,      Parse_16bit ))
-            ((Field)( destination, Parse_16bit ))
-            ((Field)( length,      Parse_16bit ))
-            ((Field)( crc,         Parse_16bit )) );
+        boost::uint16_t calcChecksum() const;
+
+        bool validateChecksum() const {
+            return checksum() == 0u || checksum() == calcChecksum();
+        }
     };
 
     /** \brief UDP packet
@@ -67,7 +65,13 @@ namespace senf {
             \ref UDPPacket
 
         \par Fields:
-            \ref Parse_UDP
+            \ref UDPPacketParser
+
+        \par Finalize action:
+            Set \a length from payload size\n
+            Calculate \a checksum
+
+        \image html UDPPacket.png
 
         \ingroup protocolbundle_default
      */
@@ -75,19 +79,22 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<UDPPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<UDPPacketType> mixin;
         typedef ConcretePacket<UDPPacketType> packet;
-        typedef Parse_UDP parser;
-
+        typedef UDPPacketParser parser;
+#endif
         using mixin::nextPacketRange;
         using mixin::initSize;
         using mixin::init;
 
         static void dump(packet p, std::ostream & os);
+
+        static void finalize(packet p);
     };
 
     /** \brief UDP packet typedef */
-    typedef UDPPacketType::packet UDPPacket;
+    typedef ConcretePacket<UDPPacketType> UDPPacket;
 }