Packets/80221Bundle: added MIHFId class
[senf.git] / Packets / DefaultBundle / IPv6Extensions.hh
index d2e9de0..197f5c9 100644 (file)
@@ -4,7 +4,7 @@
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
-//
+//     Philipp Batroff <philipp.batroff@fokus.fraunhofer.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
 // the Free Software Foundation; either version 2 of the License, or
@@ -37,6 +37,7 @@ namespace senf {
     /** \brief Parse in IPv6 fragment extension header
         
         Parser implementing the IPv6 fragment extension. The fields implemented are:
+        \image html IPv6Extensions_Fragment.png
 
         \see IPv6ExtensionType_Fragment \n
             <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
@@ -45,14 +46,14 @@ namespace senf {
     {
 #       include SENF_FIXED_PARSER()
 
-        SENF_PARSER_FIELD( nextHeader     , UInt8Parser );
-        SENF_PARSER_FIELD( reserved1      , UInt8Parser );
+        SENF_PARSER_FIELD            ( nextHeader     , UInt8Parser  );
+        SENF_PARSER_PRIVATE_FIELD    ( reserved1      , UInt8Parser  );
 
-        SENF_PARSER_BITFIELD( fragmentOffset, 13, unsigned );
-        SENF_PARSER_BITFIELD( reserved2,       2, unsigned );
-        SENF_PARSER_BITFIELD( moreFragments,   1, bool     );
+        SENF_PARSER_BITFIELD         ( fragmentOffset , 13, unsigned );
+        SENF_PARSER_PRIVATE_BITFIELD ( reserved2      ,  2, unsigned );
+        SENF_PARSER_BITFIELD         ( moreFragments  ,  1, bool     );
 
-        SENF_PARSER_FIELD( id             , UInt32Parser   );
+        SENF_PARSER_FIELD            ( id             , UInt32Parser );
 
         SENF_PARSER_FINALIZE(IPv6PacketParserExtension_Fragment);
     };
@@ -66,13 +67,11 @@ namespace senf {
             \ref IPv6PacketParserExtension_Fragment
         
         \par Associated registries:
-            \par IpTypes
+            \ref IpTypes
         
         \par Finalize action:
             Set \a nextHeader from type of next packet if found in \ref IpTypes
 
-        \image html IPv6Extensions_Fragment.png
-
         \ingroup protocolbundle_default
      */
     struct IPv6ExtensionType_Fragment
@@ -81,9 +80,12 @@ namespace senf {
     {
 #ifndef DOXYGEN
         typedef PacketTypeMixin<IPv6ExtensionType_Fragment, IpTypes> mixin;
-        typedef ConcretePacket<IPv6ExtensionType_Fragment> packet;
-        typedef IPv6PacketParserExtension_Fragment parser;
 #endif
+        /** \brief IPv6 fragment extension packet typedef */
+        typedef ConcretePacket<IPv6ExtensionType_Fragment> packet; 
+        /** \brief typedef to the parser of IPv6 fragment extension packet */
+        typedef IPv6PacketParserExtension_Fragment parser;
+
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -92,19 +94,263 @@ namespace senf {
         static key_t nextPacketKey(packet p) 
             { return p->nextHeader(); }
         
-        static void dump(packet p, std::ostream & os);
+        /** \brief Dump given IPv6Extension_Fragment in readable form to given output stream */
+        static void dump(packet p, std::ostream & os); 
 
-        static void finalize(packet p)
-            { p->nextHeader() << key(p.next(nothrow)); }
+        static void finalize(packet p) { 
+            p->nextHeader() << key(p.next(nothrow)); }
     };
 
     /** \brief IPv6 fragment extension packet typedef */
     typedef ConcretePacket<IPv6ExtensionType_Fragment> IPv6Extension_Fragment;
-}
 
-///////////////////////////////hh.e////////////////////////////////////////
+// =====================================================================================================
+
+    /** \brief Parse in IPv6 routing extension header
+
+        Parser implementing the IPv6 routing Header extension. The fields implemented are:
+    \image html IPv6Extensions_Routing.png
+
+    \see IPv6ExtensionType_Routing \n
+    <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
+     */
+
+//Routing Header Extension (type 0 only)
+    struct IPv6PacketParserExtension_Routing : public PacketParserBase
+    {
+/*
+The Type 0 Routing header has the following format: (RFC 2460)
+
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |  Next Header  |  Hdr Ext Len  | Routing Type=0| Segments Left |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |                            Reserved                           |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |                                                               |
+    +                                                               +
+    |                                                               |
+    +                           Address[1]                          +
+    |                                                               |
+    +                                                               +
+    |                                                               |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    .                               .                               .
+    .                               .                               .
+    .                               .                               .
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |                                                               |
+    +                                                               +
+    |                                                               |
+    +                           Address[n]                          +
+    |                                                               |
+    +                                                               +
+    |                                                               |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+*/
+#       include SENF_PARSER()
+        
+        SENF_PARSER_FIELD ( nextHeader, UInt8Parser      );
+        SENF_PARSER_FIELD ( headerLength, UInt8Parser    );
+        SENF_PARSER_FIELD ( routingType, UInt8Parser     ); //set to Zero for minimal implementation
+        SENF_PARSER_FIELD_RO ( segmentsLeft, UInt8Parser );
+        SENF_PARSER_FIELD ( reserved, UInt32Parser       ); //set to zero by RFC
+        SENF_PARSER_VECTOR ( hopAddresses, segmentsLeft, INet6AddressParser );
+        
+        SENF_PARSER_FINALIZE ( IPv6PacketParserExtension_Routing );
+        
+        //provisionary, since only type 0 is implemented
+        SENF_PARSER_INIT() { 
+            routingType() = 0u;
+            reserved() = 0u; 
+        }
+    };
+    
+    /** \brief IPv6 routing extension
+
+        \par Packet type (typedef):
+    \ref IPv6Extension_Routing
+
+        \par Fields:
+    \ref IPv6PacketParserExtension_Routing
+        
+        \par Associated registries:
+    \ref IpTypes
+        
+        \par Finalize action:
+    Set \a nextHeader from type of next packet if found in \ref IpTypes
+
+    \ingroup protocolbundle_default
+         */
+    
+    struct IPv6ExtensionType_Routing
+    :   public PacketTypeBase,
+        public PacketTypeMixin<IPv6ExtensionType_Routing, IpTypes>
+
+    {
+#ifndef DOXYGEN
+        typedef PacketTypeMixin<IPv6ExtensionType_Routing, IpTypes> mixin;
 #endif
-#ifndef SENF_PACKETS_DECL_ONLY
+        /** \brief IPv6 routing extension packet typedef */
+        typedef ConcretePacket<IPv6ExtensionType_Routing> packet;
+        /** \brief typedef to the parser of IPv6 routing extension packet */
+        typedef IPv6PacketParserExtension_Routing parser;
+        
+        using mixin::nextPacketRange;
+        using mixin::nextPacketType;
+        using mixin::init;
+        using mixin::initSize;
+        
+        static key_t nextPacketKey(packet p) 
+            { return p->nextHeader(); }
+        /** \brief Dump given IPv6Extension_Routing in readable form to given output stream */
+        static void dump(packet p, std::ostream & os); 
+        
+        static void finalize(packet p) { 
+            p->nextHeader() << key(p.next(nothrow)); }
+    };
+    
+    /** \brief IPv6 routing extension packet typedef */
+    typedef ConcretePacket<IPv6ExtensionType_Routing> IPv6Extension_Routing;
+
+    
+// =====================================================================================================
+    
+    /** \brief Parse in IPv6 Hop-By-Hop extension header
+
+        Parser implementing the IPv6 routing Header extension. The fields implemented are:
+    \image html IPv6Extensions_HopByHop.png
+
+    \see IPv6ExtensionType_HopByHop \n
+    <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
+    */
+
+// Hop-By-Hop skeleton without Options 
+
+    struct IPv6PacketParserExtension_HopByHop : public PacketParserBase {
+#       include SENF_PARSER()
+        SENF_PARSER_FIELD ( nextHeader, UInt8Parser   );
+        SENF_PARSER_FIELD ( headerLength, UInt8Parser );
+        
+        SENF_PARSER_FINALIZE ( IPv6PacketParserExtension_HopByHop );
+    };
+    
+    /** \brief IPv6 Hop-By-Hop extension
+
+        \par Packet type (typedef):
+    \ref IPv6Extension_HopByHop
+
+        \par Fields:
+    \ref IPv6PacketParserExtension_HopByHop
+        
+        \par Associated registries:
+    \ref IpTypes
+        
+        \par Finalize action:
+    Set \a nextHeader from type of next packet if found in \ref IpTypes
+
+    \ingroup protocolbundle_default
+    */
+    
+    struct IPv6ExtensionType_HopByHop
+    :   public PacketTypeBase,
+        public PacketTypeMixin<IPv6ExtensionType_HopByHop, IpTypes>
+    {
+#ifndef DOXYGEN
+        typedef PacketTypeMixin<IPv6ExtensionType_HopByHop, IpTypes> mixin;
+#endif
+        /** \brief IPv6 Hop-By-Hop extension packet typedef */
+        typedef ConcretePacket<IPv6ExtensionType_HopByHop> packet;
+        /** \brief typedef to the parser of IPv6 Hop-By-Hop extension packet */
+        typedef IPv6PacketParserExtension_HopByHop parser;
+        
+        using mixin::nextPacketRange;
+        using mixin::nextPacketType;
+        using mixin::init;
+        using mixin::initSize;
+        
+        static key_t nextPacketKey(packet p) 
+        { return p->nextHeader(); }
+        /** \brief Dump given IPv6Extension_HopByHop in readable form to given output stream */
+        static void dump(packet p, std::ostream & os); 
+        
+        static void finalize(packet p) { 
+            p->nextHeader() << key(p.next(nothrow)); }
+    };
+    
+    /** \brief IPv6 routing Hop-By-Hop packet typedef */
+    typedef ConcretePacket<IPv6ExtensionType_HopByHop> IPv6Extension_HopByHop;
+    
+// =====================================================================================================
+    
+    /** \brief Parse in IPv6 Destination Options extension header
+
+        Parser implementing the IPv6 Destination Options Header extension. The fields implemented are:
+    \image html IPv6Extensions_Destination.png
+
+    \see IPv6ExtensionType_Destination \n
+    <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
+     */
+    
+    // Destination Options skeleton without TLV-Options
+
+    struct IPv6PacketParserExtension_Destination : public PacketParserBase {
+#       include SENF_PARSER()
+        SENF_PARSER_FIELD ( nextHeader, UInt8Parser   );
+        SENF_PARSER_FIELD ( headerLength, UInt8Parser );
+        
+        SENF_PARSER_FINALIZE ( IPv6PacketParserExtension_Destination );
+    };
+    
+    /** \brief IPv6 Destination Options extension
+
+        \par Packet type (typedef):
+    \ref IPv6Extension_Destination
+
+        \par Fields:
+    \ref IPv6PacketParserExtension_Destination
+        
+        \par Associated registries:
+    \ref IpTypes
+        
+        \par Finalize action:
+    Set \a nextHeader from type of next packet if found in \ref IpTypes
+
+    \ingroup protocolbundle_default
+         */
+    
+    struct IPv6ExtensionType_Destination
+    :   public PacketTypeBase,
+        public PacketTypeMixin<IPv6ExtensionType_Destination, IpTypes>
+    {
+#ifndef DOXYGEN
+        typedef PacketTypeMixin<IPv6ExtensionType_Destination, IpTypes> mixin;
+#endif
+        /** \brief IPv6 Destination Options extension packet typedef */
+        typedef ConcretePacket<IPv6ExtensionType_Destination> packet;
+        /** \brief typedef to the parser of IPv6 Destination Options extension packet */
+        typedef IPv6PacketParserExtension_Destination parser;
+        
+        using mixin::nextPacketRange;
+        using mixin::nextPacketType;
+        using mixin::init;
+        using mixin::initSize;
+        
+        static key_t nextPacketKey(packet p) 
+        { return p->nextHeader(); }
+        /** \brief Dump given IPv6Extension_Destination in readable form to given output stream */
+        static void dump(packet p, std::ostream & os); 
+        
+        static void finalize(packet p) { 
+            p->nextHeader() << key(p.next(nothrow)); }
+    };
+    
+    /** \brief IPv6 routing Destination Options packet typedef */
+    typedef ConcretePacket<IPv6ExtensionType_Destination> IPv6Extension_Destination;
+
+    
+} //namespace senf
+///////////////////////////////hh.e////////////////////////////////////////
 //#include "IPv6Extensions.cci"
 //#include "IPv6Extensions.ct"
 //#include "IPv6Extensions.cti"