replaced tabs with spaces.
[senf.git] / Packets / MPEGDVBBundle / DTCPPacket.hh
index 5b43e92..128cac0 100644 (file)
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum NETwork research (NET)
-//     David Wagner <david.wagner@fokus.fraunhofer.de>
+// $Id$
 //
-#ifndef DTCPPACKET_HH_
-#define DTCPPACKET_HH_
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     David Wagner <dw6@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
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief DTCPPacket public header */
 
+#ifndef HH_DTCPPacket_
+#define HH_DTCPPacket_ 1
+
+// Custom includes
 #include "../../Packets/Packets.hh"
 #include "../../Packets/DefaultBundle/IPv4Packet.hh"
 #include "../../Packets/DefaultBundle/IPv6Packet.hh"
 
+//#include "DTCPPacket.mpp"
+///////////////////////////////hh.p////////////////////////////////////////
+
 namespace senf {
-    
-    //first we have to define some helpers
-    struct DTCPIPv4AddressListParser : public PacketParserBase {
+
+#   define DTCP_V4_MCADDRESS "224.0.0.36"
+#   define DTCP_V6_MCADDRESS "FF02:0:0:0:0:0:1:4"
+#   define DTCP_UDP_PORT 652
+
+    struct DTCPIPv4AddressListParser : public PacketParserBase 
+    {
 #       include SENF_PARSER()        
-        SENF_PARSER_PRIVATE_FIELD ( num_of_fbips, Parse_UInt8 );
-        SENF_PARSER_PRIVATE_FIELD ( reserved ,    Parse_UInt8 );   //must be zero 
-        SENF_PARSER_VEC_N         ( fbiplist,     num_of_fbips, Parse_INet4Address );
 
-       SENF_PARSER_FINALIZE(DTCPIPv4AddressListParser);
+        SENF_PARSER_PRIVATE_FIELD( fbipCount_, UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD( reserved_, UInt8Parser );
+
+        SENF_PARSER_VECTOR( fbips, fbipCount_, INet4AddressParser );
+
+        // Needed since we do NOT want to init fbipCount_ or reseverd_. And since
+        // INet4AddressParser::init() is a no-op, we can just as well disable init completely
+        SENF_PARSER_INIT() {}
+
+        SENF_PARSER_FINALIZE(DTCPIPv4AddressListParser);
     };
         
-    struct DTCPIPv6AddressListParser : public PacketParserBase {
+    struct DTCPIPv6AddressListParser : public PacketParserBase 
+    {
 #       include SENF_PARSER()        
-        SENF_PARSER_PRIVATE_FIELD ( num_of_fbips, Parse_UInt8 );
-        SENF_PARSER_PRIVATE_FIELD ( reserved,     Parse_UInt8 );   //must be zero 
-        SENF_PARSER_VEC_N         ( fbiplist,     num_of_fbips, Parse_INet6Address );
 
-       SENF_PARSER_FINALIZE(DTCPIPv6AddressListParser);
+        SENF_PARSER_PRIVATE_FIELD( fbipCount_, UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD( reserved_, UInt8Parser );
+
+        SENF_PARSER_VECTOR( fbips, fbipCount_, INet6AddressParser );
+
+        // Needed since we do NOT want to init fbipCount_ or reseverd_. And since
+        // INet4AddressParser::init() is a no-op, we can just as well disable init completely
+        SENF_PARSER_INIT() {}
+
+        SENF_PARSER_FINALIZE(DTCPIPv6AddressListParser);
     };
 
-    /** \brief Parse a DTCP packet
+    /** \brief Parse a DTCP HELLO packet
 
         Parser implementing the DTCP packet according to RFC 3077
         
         \see DTCPPacketType
      */
-    struct Parse_DTCPPacket : public PacketParserBase
+    struct DTCPHelloPacketParser : public PacketParserBase
     {
 #       include SENF_PARSER()
 
-        SENF_PARSER_BITFIELD         ( version_number,       4, unsigned );  // =1 according to rfc3077
-        SENF_PARSER_BITFIELD         ( command,              4, unsigned );  // 1=JOIN 2=LEAVE
-        SENF_PARSER_FIELD            ( interval,             Parse_UInt8 );  // 5 according to rfc3077
-        SENF_PARSER_FIELD            ( sequence_number,      Parse_UInt16 );
-        SENF_PARSER_PRIVATE_BITFIELD ( reserved,             3, unsigned );
-        SENF_PARSER_BITFIELD         ( receive_capable_feed, 1, bool );      // 0=send only, 1=receive_capable_feed
-        SENF_PARSER_BITFIELD         ( ip_version,           4, unsigned );  // 4=IPv4, 6=IPv6
-        SENF_PARSER_FIELD            ( tunnel_protocol,      Parse_UInt8 ); 
-               /* Please consider the following comments on the implementation given in this class: 
-                * 1. you could think of simply using SENF_PARSER_PRIVATE_VARIANT and List / Vectorparser like this:
-                * SENF_PARSER_PRIVATE_VARIANT  ( fbiplist,             ip_version,
-         *                                                       (senf::VoidPacketParser) //ip_version=0
-         *                                                       (senf::VoidPacketParser) //1
-         *                                                       (senf::VoidPacketParser) //2
-         *                                                       (senf::VoidPacketParser) //3
-         *                                                       (senf::Parse_ListB< IPv4Packet, num_of_fbips>) //4 
-         *                                                       (senf::VoidPacketParser) //5
-         *                                                       (senf::Parse_ListB< IPv6Packet, num_of_fbips>) ); //6
-         * This can't work for two reasons: 
-         *             -SENF_PARSER_PRIVATE_VARIANT only accepts 6 templates in types but you have to start from 0.
-         *             -you NEVER can use templated Parsers in these macros since the macro-preprocessor won't recognize the <> brackets and will
-         *                     interpret the ","
-         * 
-         * The first problem is solved by using (actually inventing)  SENF_PARSER_VARIANT_TRANS which has the same limitations 
-         *             concerning the number of types but isn't limited to the values used. This is achieved by a translating function 
-         *             as you can see. 
-         * The second problem is solved by introducing Helper-Parser which cover both the list and the number field. By that no 
-         *             templates have to be used. 
-               */
-
-               struct ip_version_translator {
-                   static unsigned fromChooser(ip_version_t::value_type in) {
-                       switch (in) { 
-                       case 4: return 0;
-                       case 6: return 1;
-                       }
-                   }
-                   static ip_version_t::value_type toChooser(unsigned in) {
-                       switch (in) {
-                           case 0: return 4;
-                           case 1: return 6; 
-                       }
-                   }
-               };
-    
-        SENF_PARSER_VARIANT_TRANS    ( fbiplist,             ip_version, ip_version_translator,
-                                                                 (senf::DTCPIPv4AddressListParser)        //IPv4 
-                                                                 (senf::DTCPIPv6AddressListParser) );     //IPv6
+        SENF_PARSER_BITFIELD         ( versionNumber,        4, unsigned );  // must be 1
+        SENF_PARSER_BITFIELD         ( command,              4, unsigned );
+
+        enum Command { JOIN=1, LEAVE=2 };
+
+        SENF_PARSER_FIELD            ( interval,             UInt8Parser );  // should be 5
+        SENF_PARSER_FIELD            ( sequenceNumber,       UInt16Parser );
+
+        SENF_PARSER_PRIVATE_BITFIELD ( reserved0_,           3, unsigned );
+        SENF_PARSER_BITFIELD         ( receiveCapableFeed,   1, bool );
+        SENF_PARSER_BITFIELD_RO      ( ipVersion,            4, unsigned );  // 4=IPv4, 6=IPv6
 
-       SENF_PARSER_FINALIZE(Parse_DTCPPacket);
+        SENF_PARSER_FIELD            ( tunnelProtocol,       UInt8Parser ); 
+        SENF_PARSER_FIELD_RO         ( fbipCount,            UInt8Parser );
+        SENF_PARSER_PRIVATE_FIELD    ( reserved1_,           UInt8Parser );  // must be zero 
+
+        // Go back to fbipCount so the variant has access to that field
+        SENF_PARSER_GOTO( fbipCount );
+
+        SENF_PARSER_VARIANT          ( fbipList_,            ipVersion,
+                           ( ids(na, has_v4fbipList, init_v4fbipList,
+                                 key(4, DTCPIPv4AddressListParser)) ) 
+                           ( ids(na, has_v6fbipList, init_v6fbipList,
+                                 key(6, DTCPIPv6AddressListParser)) ) );
+
+        // We define the two variant accessors ourselves so we can directly return the vector and
+        // not the collection parser which contains the vector ...
+
+        typedef DTCPIPv4AddressListParser::fbips_t v4fbipList_t;
+        v4fbipList_t v4fbipList() { return fbipList_().get<0>().fbips(); }
+
+        typedef DTCPIPv6AddressListParser::fbips_t v6fbipList_t;
+        v6fbipList_t v6fbipList() { return fbipList_().get<1>().fbips(); }
+                                                                 
+        SENF_PARSER_FINALIZE(DTCPHelloPacketParser);
     };
     
-    /** \brief DTCP packet
+    /** \brief DTCP HELLO packet
         
         \par Packet type (typedef):
-            \ref DTCPPacket
+            \ref DTCPHelloPacket
 
         \par Fields:
-            \ref Parse_DTCPPacket
+            \ref DTCPHelloPacketParser
 
         \ingroup protocolbundle_mpegdvb
      */
-    struct DTCPPacketType
+    struct DTCPHelloPacketType
         : public PacketTypeBase,
-          public PacketTypeMixin<DTCPPacketType>
+          public PacketTypeMixin<DTCPHelloPacketType>
     {
-        typedef PacketTypeMixin<DTCPPacketType> mixin;
-        typedef ConcretePacket<DTCPPacketType> packet;
-        typedef Parse_DTCPPacket parser;
+        typedef PacketTypeMixin<DTCPHelloPacketType> mixin;
+        typedef ConcretePacket<DTCPHelloPacketType> packet;
+        typedef DTCPHelloPacketParser parser;
     
         using mixin::nextPacketRange;
         using mixin::init;
@@ -119,7 +145,22 @@ namespace senf {
     };
     
     /** \brief DTCP packet typedef */
-    typedef DTCPPacketType::packet DTCPPacket;
+    typedef DTCPHelloPacketType::packet DTCPHelloPacket;
 }
 
-#endif /*DTCPPACKET_HH_*/
+///////////////////////////////hh.e////////////////////////////////////////
+//#include "DTCPPacket.cci"
+//#include "DTCPPacket.ct"
+//#include "DTCPPacket.cti"
+#endif
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// comment-column: 40
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// End: