Move include files in debian packge into 'senf' subdirectory
[senf.git] / Packets / DefaultBundle / IpV4Packet.hh
index 94a6823..5fc143e 100644 (file)
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief IpV4Packet public header */
+
 #ifndef HH_IpV4Packet_
 #define HH_IpV4Packet_ 1
 
 // Custom includes
-#include "Packets/Packets.hh"
+#include "../../Socket/Protocols/INet/INet4Address.hh"
+#include "../../Packets/Packets.hh"
 
 //#include "IpV4Packet.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
 
+    /** \brief Parse in IpV4 address
+
+        \see INet4Address
+     */
+    struct Parse_INet4Address : public PacketParserBase
+    {
+        Parse_INet4Address(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
+
+        ///////////////////////////////////////////////////////////////////////////
+
+        typedef INet4Address value_type;
+        static const size_type fixed_bytes = 4u;
+
+        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_INet4Address const & operator= (value_type const & other) 
+            { value(other); return *this; }
+    };
+
     /** \brief Parse an IpV4 packet
 
         Parser implementing the IpV4 header. The fields implemented are:
 
-        <table class="senf">
-            <tr><th>Field name</th><th>Parser type</th></tr>
-            <tr><td>version</td><td>\ref Parse_Version</td></tr>
-            <tr><td>ihl</td><td>\ref Parse_IHL</td></tr>
-            <tr><td>tos</td><td>\ref Parse_8bit</td></tr>
-            <tr><td>length</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>identifier</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>reserved</td><td>\ref Parse_R</td></tr>
-            <tr><td>df</td><td>\ref Parse_DF</td></tr>
-            <tr><td>mf</td><td>\ref Parse_MF</td></tr>
-            <tr><td>frag</td><td>\ref Parse_Frag</td></tr>
-            <tr><td>ttl</td><td>\ref Parse_8bit</td></tr>
-            <tr><td>protocol</td><td>\ref Parse_8bit</td></tr>
-            <tr><td>crc</td><td>\ref Parse_16bit</td></tr>
-            <tr><td>source</td><td>\ref Parse_32bit</td></tr>
-            <tr><td>destination</td><td>\ref Parse_32bit</td></tr>
-        </table>
-
         \see IpV4PacketType \n
             <a href="http://tools.ietf.org/html/rfc791">RFC 791</a>
 
@@ -60,10 +67,6 @@ namespace senf {
      */
     struct Parse_IpV4 : public PacketParserBase
     {
-        SENF_PACKET_PARSER_NO_INIT(Parse_IpV4);
-
-        ///////////////////////////////////////////////////////////////////////////
-
         typedef Parse_UIntField <  0,  4 > Parse_Version;
         typedef Parse_UIntField <  4,  8 > Parse_IHL;
         typedef Parse_UInt8                Parse_8bit;
@@ -73,6 +76,11 @@ namespace senf {
         typedef Parse_Flag      <  2     > Parse_MF;
         typedef Parse_UIntField <  3, 16 > Parse_Frag;
         typedef Parse_UInt32               Parse_32bit;
+        typedef Parse_INet4Address         Parse_Addr;
+
+#       ifndef DOXYGEN
+
+        SENF_PACKET_PARSER_NO_INIT(Parse_IpV4);
 
         SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
             ((OverlayField)( version,     Parse_Version ))
@@ -87,8 +95,27 @@ namespace senf {
             ((Field       )( ttl,         Parse_8bit    ))
             ((Field       )( protocol,    Parse_8bit    ))
             ((Field       )( crc,         Parse_16bit   ))
-            ((Field       )( source,      Parse_32bit   ))
-            ((Field       )( destination, Parse_32bit   )) );
+            ((Field       )( source,      Parse_Addr    ))
+            ((Field       )( destination, Parse_Addr    )) );
+
+#       else
+
+        Parse_Version version() const;
+        Parse_IHL     ihl() const;
+        Parse_8bit    tos() const;
+        Parse_16bit   length() const;
+        Parse_16bit   identifier() const;
+        Parse_R       reserved() const;
+        Parse_DF      df() const;
+        Parse_MF      mf() const;
+        Parse_Frag    frag() const;
+        Parse_8bit    ttl() const;
+        Parse_8bit    protocol() const;
+        Parse_16bit   crc() const;
+        Parse_Addr    source() const;
+        Parse_Addr    destination() const;
+
+#       endif
 
         void init() {
             version() = 4;
@@ -99,7 +126,7 @@ namespace senf {
 
         This registeres packets with their IP protocol number.
 
-        \see <a href="http://www.iana.org/assignments/protocol-numbers">Protocol numbers</a>
+        \see <a href="http://www.iana.org/assignments/protocol-numbers">Protocol numbers</a> \n
             PacketRegistry
      */
     struct IpTypes {