- Added Unittests for all ICMPv6 - MLDv2 Packet Types
[senf.git] / Packets / DefaultBundle / ICMPv6TypePacket.hh
index 0b28c35..7196f4f 100644 (file)
@@ -1,9 +1,9 @@
-// $Id: main.test.cc 206 2008-06-08 14:20:52Z pug $
+// $Id$
 //
-// Copyright (C) 2006
+// Copyright (C) 2008
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Philipp Batroff <Philipp.Batroff@fokus.fraunhofer.de>
+//     Philipp Batroff <pug@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
 
 // Definition of non-inline non-template functions
 
-#ifndef HH_ICMPV6TYPEPacket
-#define HH_ICMPV6TYPEPacket
+#ifndef HH_SENF_Packets_DefaultBundle_ICMPv6TypePacket_
+#define HH_SENF_Packets_DefaultBundle_ICMPv6TypePacket_ 1
+
 // Custom includes
 #include "../../Packets/Packets.hh"
 #include "ICMPv6Packet.hh"
 
-namespace senf{
+namespace senf {
+
     //#############################################################
     //ICMPv6 Echo Request
     //#############################################################
-    struct ICMPV6EchoRequestParser : public senf::PacketParserBase
+    struct ICMPv6EchoRequestParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
-        SENF_PARSER_FIELD    ( identifier, senf::UInt16Parser );
-        SENF_PARSER_FIELD    ( seqNr, senf::UInt16Parser );
+#       include SENF_FIXED_PARSER()
+        SENF_PARSER_FIELD ( identifier, UInt16Parser );
+        SENF_PARSER_FIELD ( seqNr,      UInt16Parser );
         
-        SENF_PARSER_FINALIZE ( ICMPV6EchoRequestParser );
+        SENF_PARSER_FINALIZE ( ICMPv6EchoRequestParser );
     };
     
-    struct ICMPV6EchoRequestType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6EchoRequestType>
+    /** \brief ICMPv6 Echo Request
+
+        \par Packet type (typedef):
+            \ref ICMPv6EchoRequest
+
+        \par Fields:
+            \ref ICMPv6EchoRequestParser
+            \image html ICMPv6EchoRequest.png
+
+        \ingroup protocolbundle_default
+     */
+    struct ICMPv6EchoRequestType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6EchoRequestType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6EchoRequestType> mixin;
-        typedef senf::ConcretePacket<ICMPV6EchoRequestType> packet;
-        typedef ICMPV6EchoRequestParser parser;
+        typedef PacketTypeMixin<ICMPv6EchoRequestType> mixin;
+        typedef ConcretePacket<ICMPv6EchoRequestType> packet;
+        typedef ICMPv6EchoRequestParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
     
-    typedef ICMPV6EchoRequestType::packet ICMPv6EchoReq;
+    typedef ConcretePacket<ICMPv6EchoRequestType> ICMPv6EchoRequest;
     
     //#############################################################
     //ICMPv6 Echo Reply
     //#############################################################
-    struct ICMPV6EchoReplyParser : public senf::PacketParserBase
+    struct ICMPv6EchoReplyParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
-        SENF_PARSER_FIELD    ( identifier, senf::UInt16Parser );
-        SENF_PARSER_FIELD    ( seqNr, senf::UInt16Parser );
+#       include SENF_FIXED_PARSER()
+        SENF_PARSER_FIELD ( identifier, UInt16Parser );
+        SENF_PARSER_FIELD ( seqNr,      UInt16Parser );
         
-        SENF_PARSER_FINALIZE ( ICMPV6EchoReplyParser );
+        SENF_PARSER_FINALIZE ( ICMPv6EchoReplyParser );
     };
     
-    struct ICMPV6EchoReplyType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6EchoReplyType>
+    /** \brief ICMPv6 Echo Reply
+
+        \par Packet type (typedef):
+            \ref ICMPv6EchoReply
+
+        \par Fields:
+            \ref ICMPv6EchoReplyParser
+            \image html ICMPv6EchoReply.png
+
+        \ingroup protocolbundle_default
+     */
+    struct ICMPv6EchoReplyType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6EchoReplyType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6EchoReplyType> mixin;
-        typedef senf::ConcretePacket<ICMPV6EchoReplyType> packet;
-        typedef ICMPV6EchoReplyParser parser;
+        typedef PacketTypeMixin<ICMPv6EchoReplyType> mixin;
+        typedef ConcretePacket<ICMPv6EchoReplyType> packet;
+        typedef ICMPv6EchoReplyParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef ICMPV6EchoReplyType::packet ICMPv6EchoReply;
+        
+    typedef ConcretePacket<ICMPv6EchoReplyType> ICMPv6EchoReply;
     
     //#############################################################
     //ICMPv6 Error Destination Unreachable Message
     //#############################################################
-    struct ICMPV6ErrDestUnreachableParser : public senf::PacketParserBase
+    struct ICMPv6ErrDestUnreachableParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
+#       include SENF_FIXED_PARSER()
+        
         //should be set static 0 by sender and ignored by receiver
-        SENF_PARSER_PRIVATE_FIELD    ( unused, senf::UInt32Parser );
+        SENF_PARSER_PRIVATE_FIELD ( unused, UInt32Parser );
         
-        SENF_PARSER_INIT() { unused() = 0; }
+        SENF_PARSER_INIT() { 
+            unused() = 0; 
+        }
         /*   Code     0 - No route to destination
                     1 - Communication with destination
                             administratively prohibited
@@ -100,131 +128,177 @@ namespace senf{
                     4 - Port unreachable
                     5 - Source address failed ingress/egress policy
                     6 - Reject route to destination   */
-        void setErrCode(int code){
+        void setErrCode(int code) {
             ICMPv6Packet icmpv6 (senf::Packet().rfind<ICMPv6Packet>(senf::nothrow));
             icmpv6->code() = code;
         }
         
-        SENF_PARSER_FINALIZE ( ICMPV6ErrDestUnreachableParser );
+        SENF_PARSER_FINALIZE ( ICMPv6ErrDestUnreachableParser );
     };
     
-    struct ICMPV6ErrDestUnreachableType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6ErrDestUnreachableType>
+    /** \brief ICMPv6 Destination unreachable
+
+        \par Packet type (typedef):
+            \ref ICMPv6ErrDestUnreachable
+
+        \par Fields:
+            \ref ICMPv6ErrDestUnreachableParser
+            \image html ICMPv6ErrDestUnreachable.png
+        \ingroup protocolbundle_default
+    */
+    struct ICMPv6ErrDestUnreachableType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6ErrDestUnreachableType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6ErrDestUnreachableType> mixin;
-        typedef senf::ConcretePacket<ICMPV6ErrDestUnreachableType> packet;
-        typedef ICMPV6ErrDestUnreachableParser parser;
+        typedef PacketTypeMixin<ICMPv6ErrDestUnreachableType> mixin;
+        typedef ConcretePacket<ICMPv6ErrDestUnreachableType> packet;
+        typedef ICMPv6ErrDestUnreachableParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef ICMPV6ErrDestUnreachableType::packet ICMPV6ErrDestUnreachable;
+        
+    typedef ConcretePacket<ICMPv6ErrDestUnreachableType> ICMPv6ErrDestUnreachable;
     
     //#############################################################
     //ICMPv6 Error Packet Too Big Message
     //#############################################################
-    struct ICMPV6ErrTooBigParser : public senf::PacketParserBase
+    struct ICMPv6ErrTooBigParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
-        SENF_PARSER_FIELD    ( MTU, senf::UInt32Parser );
+#       include SENF_FIXED_PARSER()
+        SENF_PARSER_FIELD ( mtu, UInt32Parser );
     
         /*   Code     static set to 0       */
     //     SENF_PARSER_INIT() {
-    //         ICMPv6Packet icmpv6 (senf::Packet().rfind<ICMPv6Packet>(senf::nothrow));
+    //         ICMPv6Packet icmpv6 (packet().rfind<ICMPv6Packet>(senf::nothrow));
     //         icmpv6->code() = 0;
     //     }
         
-        SENF_PARSER_FINALIZE ( ICMPV6ErrTooBigParser );
+        SENF_PARSER_FINALIZE ( ICMPv6ErrTooBigParser );
     };
     
-    struct ICMPV6ErrTooBigType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6ErrTooBigType>
+    /** \brief ICMPv6 Packet to big
+
+        \par Packet type (typedef):
+            \ref ICMPv6ErrTooBig
+
+        \par Fields:
+            \ref ICMPv6ErrTooBigParser
+            \image html ICMPv6ErrTooBig.png
+
+        \ingroup protocolbundle_default
+     */
+    struct ICMPv6ErrTooBigType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6ErrTooBigType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6ErrTooBigType> mixin;
-        typedef senf::ConcretePacket<ICMPV6ErrTooBigType> packet;
-        typedef ICMPV6ErrTooBigParser parser;
+        typedef PacketTypeMixin<ICMPv6ErrTooBigType> mixin;
+        typedef ConcretePacket<ICMPv6ErrTooBigType> packet;
+        typedef ICMPv6ErrTooBigParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef ICMPV6ErrTooBigType::packet ICMPV6ErrTooBig;
+
+    typedef ConcretePacket<ICMPv6ErrTooBigType> ICMPv6ErrTooBig;
     
     //#############################################################
     //ICMPv6 Error Time Exceeded Message
     //#############################################################
-    struct ICMPV6ErrTimeExceededParser : public senf::PacketParserBase
+    struct ICMPv6ErrTimeExceededParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
+#       include SENF_FIXED_PARSER()
         //should be set static 0 by sender and ignored by receiver
-        SENF_PARSER_FIELD    ( unused, senf::UInt32Parser );
+        SENF_PARSER_FIELD    ( unused, UInt32Parser );
         /*  Code    0 - Hop limit exceeded in transit
                     1 - Fragment reassembly time exceeded   */
         void setErrCode(int code){
-            ICMPv6Packet icmpv6 (senf::Packet().rfind<ICMPv6Packet>(senf::nothrow));
+            ICMPv6Packet icmpv6 (packet().rfind<ICMPv6Packet>(senf::nothrow));
             icmpv6->code() = code;
         }
         
-        SENF_PARSER_FINALIZE ( ICMPV6ErrTimeExceededParser );
+        SENF_PARSER_FINALIZE ( ICMPv6ErrTimeExceededParser );
     };
     
-    struct ICMPV6ErrTimeExceededType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6ErrTimeExceededType>
+    /** \brief ICMPv6 Time exceeded
+
+        \par Packet type (typedef):
+            \ref ICMPv6ErrTimeExceeded
+
+        \par Fields:
+            \ref ICMPv6ErrTimeExceededParser
+            \image html ICMPv6ErrTimeExceeded.png
+
+        \ingroup protocolbundle_default
+     */
+    struct ICMPv6ErrTimeExceededType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6ErrTimeExceededType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6ErrTimeExceededType> mixin;
-        typedef senf::ConcretePacket<ICMPV6ErrTimeExceededType> packet;
-        typedef ICMPV6ErrTimeExceededParser parser;
+        typedef PacketTypeMixin<ICMPv6ErrTimeExceededType> mixin;
+        typedef ConcretePacket<ICMPv6ErrTimeExceededType> packet;
+        typedef ICMPv6ErrTimeExceededParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef ICMPV6ErrTimeExceededType::packet ICMPV6ErrTimeExceeded;
+    typedef ConcretePacket<ICMPv6ErrTimeExceededType> ICMPv6ErrTimeExceeded;
     
     //#############################################################
     //ICMPv6 Error Parameter Problem Message
     //#############################################################
-    struct ICMPV6ErrParamProblemParser : public senf::PacketParserBase
+    struct ICMPv6ErrParamProblemParser : public PacketParserBase
     {
-    #       include SENF_FIXED_PARSER()
+#       include SENF_FIXED_PARSER()
         //should be set static 0 by sender and ignored by receiver
-        SENF_PARSER_FIELD    ( pointer, senf::UInt32Parser );
+        SENF_PARSER_FIELD ( pointer, UInt32Parser );
         /*  Code      0 - Erroneous header field encountered
                     1 - Unrecognized Next Header type encountered
                     2 - Unrecognized IPv6 option encountered          */
         
         void setErrCode(int code){
-            ICMPv6Packet icmpv6 (senf::Packet().rfind<ICMPv6Packet>(senf::nothrow));
+            ICMPv6Packet icmpv6 (packet().rfind<ICMPv6Packet>(senf::nothrow));
             icmpv6->code() = code;
         }
-        SENF_PARSER_FINALIZE ( ICMPV6ErrParamProblemParser );
+        SENF_PARSER_FINALIZE ( ICMPv6ErrParamProblemParser );
     };
     
-    struct ICMPV6ErrParamProblemType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<ICMPV6ErrParamProblemType>
+    /** \brief ICMPv6 Parameter problem
+
+        \par Packet type (typedef):
+            \ref ICMPv6ErrParamProblem
+
+        \par Fields:
+            \ref ICMPv6ErrParamProblemParser
+            \image html ICMPv6ErrParamProblem.png
+
+        \ingroup protocolbundle_default
+     */
+    struct ICMPv6ErrParamProblemType
+        : public PacketTypeBase,
+          public PacketTypeMixin<ICMPv6ErrParamProblemType>
     {
-        typedef senf::PacketTypeMixin<ICMPV6ErrParamProblemType> mixin;
-        typedef senf::ConcretePacket<ICMPV6ErrParamProblemType> packet;
-        typedef ICMPV6ErrParamProblemParser parser;
+        typedef PacketTypeMixin<ICMPv6ErrParamProblemType> mixin;
+        typedef ConcretePacket<ICMPv6ErrParamProblemType> packet;
+        typedef ICMPv6ErrParamProblemParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef ICMPV6ErrParamProblemType::packet ICMPV6ErrParamProblem;
+    typedef ConcretePacket<ICMPv6ErrParamProblemType> ICMPv6ErrParamProblem;
     
     //#############################################################
     //ICMPv6 MLDv2 (RFC 3810) Multicast Listener Query
     //#############################################################
-    struct MLDv2ListenerQueryParser : public senf::PacketParserBase
+    struct MLDv2ListenerQueryParser : public PacketParserBase
     {
-    #   include SENF_PARSER()
-    //need a variant here
+#      include SENF_PARSER()
+        //need a variant here
         // a.) maxResponseCode < 32768 =>Interger
         // b.) maxResponseCode >=32768 => float (is there a float parser???)
         /* 
@@ -234,81 +308,120 @@ namespace senf{
         |1| exp |          mant         |
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */
         
-        SENF_PARSER_FIELD   ( maxResponseCode, senf::UInt16Parser );
-        SENF_PARSER_FIELD   ( reserved, senf::UInt16Parser );   //set to zero by default
-        SENF_PARSER_FIELD   ( mcAddress, senf::INet6AddressParser);
-        SENF_PARSER_BITFIELD ( resv, 4, unsigned);              //set to zero by default
-        SENF_PARSER_BITFIELD ( sFlag, 1, unsigned);
-        SENF_PARSER_BITFIELD ( qrv, 3, unsigned);
-        SENF_PARSER_FIELD ( qqic, senf::UInt8Parser );
-        SENF_PARSER_PRIVATE_FIELD ( nrSources, senf::UInt16Parser );
-        SENF_PARSER_VECTOR  (srcAddresses, nrSources, senf::INet6AddressParser );
+        SENF_PARSER_FIELD ( maxResponseCode, UInt16Parser       );
+        SENF_PARSER_FIELD ( reserved,        UInt16Parser       ); // set to zero by default
+        SENF_PARSER_FIELD ( mcAddress,       INet6AddressParser );
+        SENF_PARSER_BITFIELD ( resv,  4, unsigned ); // set to zero by default
+        SENF_PARSER_BITFIELD ( sFlag, 1, unsigned );
+        SENF_PARSER_BITFIELD ( qrv,   3, unsigned );
+        SENF_PARSER_FIELD    ( qqic, UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD ( nrSources, UInt16Parser );
+        SENF_PARSER_VECTOR   (srcAddresses, nrSources, INet6AddressParser );
+        
+        SENF_PARSER_FINALIZE ( MLDv2ListenerQueryParser );
         
-        SENF_PARSER_INIT() 
-        { 
+        SENF_PARSER_INIT() { 
             reserved() = 0; 
             resv() = 0;
         }
-        SENF_PARSER_FINALIZE ( MLDv2ListenerQueryParser );
-        
     };
     
+    /** \brief MLDv2 Listener query
+
+        \par Packet type (typedef):
+           \ref MLDv2ListenerQuery
+
+        \par Fields:
+            \ref MLDv2ListenerQueryParser
+            \image html MLDv2ListenerQuery.png
+
+        \ingroup protocolbundle_default
+     */
     struct MLDv2ListenerQueryType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<MLDv2ListenerQueryType>
+        : public PacketTypeBase,
+          public PacketTypeMixin<MLDv2ListenerQueryType>
     {
-        typedef senf::PacketTypeMixin<MLDv2ListenerQueryType> mixin;
-        typedef senf::ConcretePacket<MLDv2ListenerQueryType> packet;
+        typedef PacketTypeMixin<MLDv2ListenerQueryType> mixin;
+        typedef ConcretePacket<MLDv2ListenerQueryType> packet;
         typedef MLDv2ListenerQueryParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef MLDv2ListenerQueryType::packet MLDv2ListenerQuery;
+        
+    typedef ConcretePacket<MLDv2ListenerQueryType> MLDv2ListenerQuery;
     
     //#############################################################
     //ICMPv6 MLDv2 (RFC 3810) Multicast Listener Report Message
     //#############################################################
     //First: the Multicast Address Record Parser
-    struct MLDv2AddressRecordParser : public senf::PacketParserBase
+    struct MLDv2AddressRecordParser : public PacketParserBase
     {
-    #   include SENF_PARSER()
-        SENF_PARSER_FIELD   ( recordType, senf::UInt8Parser );
-        SENF_PARSER_PRIVATE_FIELD   ( auxDataLen, senf::UInt8Parser );
-        SENF_PARSER_PRIVATE_FIELD   ( nrOfSrcs, senf::UInt16Parser );
-        SENF_PARSER_FIELD   ( mcAddress, senf::INet6AddressParser);
-        SENF_PARSER_VECTOR  ( srcAddresses, nrOfSrcs, senf::INet6AddressParser );
-        SENF_PARSER_VECTOR  ( auxData, auxDataLen, senf::UInt32Parser );
+#       include SENF_PARSER()
         
+        SENF_PARSER_FIELD   ( recordType, UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD   ( auxDataLen, UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD   ( nrOfSrcs, UInt16Parser );
+        SENF_PARSER_FIELD   ( mcAddress, INet6AddressParser);
+        SENF_PARSER_VECTOR  ( srcAddresses, nrOfSrcs, INet6AddressParser );
+        SENF_PARSER_VECTOR  ( auxData, auxDataLen, UInt32Parser );
         
         SENF_PARSER_FINALIZE ( MLDv2AddressRecordParser );
     };
     
-    struct MLDv2ListenerReportParser : public senf::PacketParserBase
+    struct MLDv2ListenerReportParser : public PacketParserBase
     {
-    #   include SENF_PARSER()
-        SENF_PARSER_FIELD   ( reserved, senf::UInt16Parser );   //set to zero by default
-        SENF_PARSER_PRIVATE_FIELD   ( nrMcastAddrRecords_, senf::UInt16Parser );
-        SENF_PARSER_LIST    ( mcastAddrRecords, nrMcastAddrRecords_, MLDv2AddressRecordParser );
+#       include SENF_PARSER()
         
-        SENF_PARSER_INIT() { reserved() = 0; }
+        SENF_PARSER_FIELD   ( reserved, UInt16Parser );   //set to zero by default
+        SENF_PARSER_PRIVATE_FIELD   ( nrMcastAddrRecords_, UInt16Parser );
+        SENF_PARSER_LIST    ( mcastAddrRecords, nrMcastAddrRecords_, MLDv2AddressRecordParser );
         
         SENF_PARSER_FINALIZE ( MLDv2ListenerReportParser );
+        
+        SENF_PARSER_INIT() { 
+            reserved() = 0; 
+        }
     };
     
+    /** \brief MLDv2 Listener report
+
+        \par Packet type (typedef):
+           \ref MLDv2ListenerReport
+
+        \par Fields:
+            \ref MLDv2ListenerReportParser
+            \image html MLDv2ListenerReport.png
+            \image html MLDv2AddressRecord.png
+
+        \ingroup protocolbundle_default
+     */
     struct MLDv2ListenerReportType
-            : public senf::PacketTypeBase,
-            public senf::PacketTypeMixin<MLDv2ListenerReportType>
+        : public PacketTypeBase,
+          public PacketTypeMixin<MLDv2ListenerReportType>
     {
-        typedef senf::PacketTypeMixin<MLDv2ListenerReportType> mixin;
-        typedef senf::ConcretePacket<MLDv2ListenerReportType> packet;
+        typedef PacketTypeMixin<MLDv2ListenerReportType> mixin;
+        typedef ConcretePacket<MLDv2ListenerReportType> packet;
         typedef MLDv2ListenerReportParser parser;
         
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
     };
-    typedef MLDv2ListenerReportType::packet MLDv2ListenerReport;
+        
+    typedef ConcretePacket<MLDv2ListenerReportType> MLDv2ListenerReport;
 }
+
 #endif
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
+// End: