Packets/DefaultBundle: Document finalize() action

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

diff --git a/Packets/DefaultBundle/IpV6Packet.hh b/Packets/DefaultBundle/IpV6Packet.hh
index b40ab92..da0b046 100644 (file)
--- a/Packets/DefaultBundle/IpV6Packet.hh
+++ b/Packets/DefaultBundle/IpV6Packet.hh
@@ -25,11 +25,8 @@
 #define HH_IpV6Packet_ 1
 
 // Custom includes
-#include "Packets/PacketType.hh"
-#include "Packets/ParseInt.hh"
-#include "Packets/PacketRegistry.hh"
-#include "Packets/PacketParser.hh"
-#include "Packets/ParseArray.hh"
+#include "../../Socket/Protocols/INet/INet6Address.hh"
+#include "../../Packets/Packets.hh"
 #include "IpV4Packet.hh"
 
 //#include "IpV6Packet.mpp"
@@ -37,36 +34,70 @@
 
 namespace senf {
 
-    // See RFC2460
-    struct Parse_IpV6 : public PacketParserBase
+    /** \brief Parse an IpV6 address
+        
+        \see INet6Address
+     */
+    struct Parse_INet6Address : public PacketParserBase
     {
-        SENF_PACKET_PARSER_NO_INIT(Parse_IpV6);
+        Parse_INet6Address(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
 
         ///////////////////////////////////////////////////////////////////////////
 
-        typedef Parse_UIntField <  0,  4 > Parse_Version;
-        typedef Parse_UIntField <  4, 12 > Parse_Class;
-        typedef Parse_UIntField < 12, 32 > Parse_FlowLabel;
-        typedef Parse_UInt8                Parse_8bit;
-        typedef Parse_UInt16               Parse_16bit;
-
-        typedef Parse_Array < 16, Parse_8bit > Parse_Addr;
-
-        SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((OverlayField)( version,      Parse_Version   ))
-            ((OverlayField)( trafficClass, Parse_Class     ))
-            ((Field       )( flowLabel,    Parse_FlowLabel ))
-            ((Field       )( length,       Parse_16bit     ))
-            ((Field       )( nextHeader,   Parse_8bit      ))
-            ((Field       )( hopLimit,     Parse_8bit      ))
-            ((Field       )( source,       Parse_Addr      ))
-            ((Field       )( destination,  Parse_Addr      )) );
-
-        void init() {
+        typedef INet6Address value_type;
+        static const size_type fixed_bytes = 16u;
+
+        value_type value() const { return value_type::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); }
+        Parse_INet6Address const & operator= (value_type const & other) 
+            { value(other); return *this; }
+    };
+
+    /** \brief Parse an IpV6 packet
+
+        \see IpV6PacketType \n
+            <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
+     */
+    struct Parse_IpV6 : public PacketParserBase
+    {
+#       include SENF_FIXED_PARSER()
+
+        SENF_PARSER_BITFIELD( version,       4, unsigned );
+        SENF_PARSER_BITFIELD( trafficClass,  8, unsigned );
+        SENF_PARSER_BITFIELD( flowLabel,    20, unsigned );
+
+        SENF_PARSER_FIELD( length,       Parse_UInt16       );
+        SENF_PARSER_FIELD( nextHeader,   Parse_UInt8        );
+        SENF_PARSER_FIELD( hopLimit,     Parse_UInt8        );
+        SENF_PARSER_FIELD( source,       Parse_INet6Address );
+        SENF_PARSER_FIELD( destination,  Parse_INet6Address );
+
+        SENF_PARSER_INIT() {
             version() = 6;
         }
+
+        SENF_PARSER_FINALIZE(Parse_IpV6);
     };
 
+    /** \brief IpV6 packet
+
+        \par Packet type (typedef):
+            \ref IpV6Packet
+        
+        \par Fields:
+            \ref Parse_IpV6
+
+        \par Associated registries:
+            \ref IpTypes
+
+        \par Finalize action:
+            Set \a length from payload size\n
+            Set \a nextHeader from type of next packet if found in \ref IpTypes
+
+        \ingroup protocolbundle_default
+     */
     struct IpV6PacketType
         : public PacketTypeBase,
           public PacketTypeMixin<IpV6PacketType, IpTypes>
@@ -84,13 +115,19 @@ namespace senf {
             { return p->nextHeader(); }
         
         static void dump(packet p, std::ostream & os);
+
+        static void finalize(packet p);
     };
 
+    /** \brief IpV6 packet typedef */
     typedef IpV6PacketType::packet IpV6Packet;
 
+    ///@}
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
+#endif
+#ifndef SENF_PACKETS_DECL_ONLY
 //#include "IpV6Packet.cci"
 //#include "IpV6Packet.ct"
 //#include "IpV6Packet.cti"