Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / 80211Bundle / WLANBeaconPacket.hh
index 1e762e1..25b631b 100644 (file)
@@ -1,9 +1,10 @@
 // $Id$
 //
-// Copyright (C) 2008
+// Copyright (C) 2009
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Christian Niephaus <cni@berlios.de>
+//     Thorsten Horstmann <tho@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
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief 802.11 WLANPacket public header */
+    \brief 802.11 WLAN Beacon Packet public header */
 
 #ifndef HH_SENF_Packets_80211Bundle_WLANBeaconPacket_
 #define HH_SENF_Packets_80211Bundle_WLANBeaconPacket_ 1
 
-#include <senf/Packets/Packets.hh>
+// Custom includes
+#include "InformationElements.hh"
 
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+namespace senf {
 
-namespace senf
-{
-
-    /** \brief 802.11 Beacon Frame parser
-        (see IEEE 802.11-2007 standard - Chapter 7.2.3.1 Frame formats)
-        <b>Re-ordering of bits due to host byte order</b>
+    struct WLANBeaconPacketParser : public PacketParserBase
+    {
+    #   include SENF_PARSER()
 
-        Frame base class.
-     */
+        SENF_PARSER_FIELD( timestamp,      UInt64LSBParser   );
+        SENF_PARSER_FIELD( beaconInterval, UInt16LSBParser   );
+        SENF_PARSER_SKIP ( 2,2); //capability flags
 
-//    struct WLANBeaconPacketParser : public senf::PacketParserBase
-//    {
-//        #include SENF_PARSER();
-//        SENF_PARSER_FIELD( elementId, UInt8Parser);
-//        SENF_PARSER_FIELD( length, UInt8Parser);
-//        
-//    }
+        SENF_PARSER_FIELD( ssidIE, WLANSSIDInfoElementParser );
+        WLANSSIDInfoElementParser::value_t ssid() const { return ssidIE().value(); }
 
+        SENF_PARSER_FIELD( supportedRatesIE, WLANSupportedRatesInfoElementParser );
 
-    struct WLANBeaconPacketParser : public senf::PacketParserBase
-    {
-    #   include SENF_PARSER()
+        SENF_PARSER_LIST ( ieList, packetSize(), WLANGenericInfoElementParser );
 
-        SENF_PARSER_FIELD(timestamp, UInt64LSBParser);
-        SENF_PARSER_FIELD(beaconInterval, UInt16LSBParser);
-        SENF_PARSER_SKIP(2,2); //capability flags
-
-        //SSID element
-//        SENF_PARSER_FIELD()
-        
-        SENF_PARSER_FINALIZE(WLANBeaconPacketParser);
-        
+        SENF_PARSER_FINALIZE( WLANBeaconPacketParser );
     };
 
+
     /** \brief WLAN Beacon frame packet
 
         \par Packet type (typedef):
-            \refWLANBeaconPacket
+            \ref WLANBeaconPacket
 
         \par Fields:
-            \ref WLANBeaconPacket_MgtFrameParser
-            \image html WLANBeaconPacket.png
 
         \ingroup protocolbundle_80211
      */
     struct WLANBeaconPacketType
-        : public senf::PacketTypeBase,
-          public senf::PacketTypeMixin<WLANBeaconPacketType>
+        : public PacketTypeBase,
+          public PacketTypeMixin<WLANBeaconPacketType>
     {
-        typedef senf::PacketTypeMixin<WLANBeaconPacketType> mixin;
-        typedef senf::ConcretePacket<WLANBeaconPacketType> packet;
+        typedef PacketTypeMixin<WLANBeaconPacketType> mixin;
+        typedef ConcretePacket<WLANBeaconPacketType> packet;
         typedef WLANBeaconPacketParser parser;
 
         using mixin::init;
         using mixin::initSize;
-        using senf::PacketTypeBase::nextPacketRange;
+        using PacketTypeBase::nextPacketRange;
 
         static void dump(packet p, std::ostream &os);
     };
 
+    /** \brief WLAN Beacon frame packet typedef
+        \ingroup protocolbundle_80211
+     */
     typedef ConcretePacket<WLANBeaconPacketType> WLANBeaconPacket;
 
-
 }
 
-#endif /* HH_SENF_Packets_80211Bundle_WLANBeaconPacket_ */
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+//#include "WLANBeaconPacket.cci"
+//#include "WLANBeaconPacket.ct"
+//#include "WLANBeaconPacket.cti"
+#endif
 
 \f
 // Local Variables: