switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / DefaultBundle / EthernetPacket.hh
index 51a2389..40d9eb9 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2006
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     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
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// 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.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// 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.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Thorsten Horstmann <tho@berlios.de>
 
 /** \file
     \brief EthernetPacket public header */
 #define HH_SENF_Packets_DefaultBundle_EthernetPacket_ 1
 
 // Custom includes
-#include <algorithm>
-#include "../../Socket/Protocols/Raw/MACAddress.hh"
-#include "../../Packets/Packets.hh"
+#include <senf/Socket/Protocols/Raw/MACAddress.hh>
+#include <senf/Packets/Packets.hh>
 
 //#include "EthernetPacket.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
-    /** \brief Parse an Ethernet MAC address 
+    /** \brief Parse an Ethernet MAC address
 
         The ethernet MAC is returned by value as a 6-byte sequence
 
         \see MACAddress \n
             EthernetPacket
      */
-    struct MACAddressParser : public PacketParserBase
+    struct MACAddressParser
+        : public ValueParserBase<MACAddressParser, MACAddress, 6u>
     {
-        MACAddressParser(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
-       
-        ///////////////////////////////////////////////////////////////////////////
-
-        typedef MACAddress value_type;
-        static const size_type fixed_bytes = 6u;
+        MACAddressParser(data_iterator i, state_type s) : Base(i,s) {}
 
         value_type value() const { return MACAddress::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);  }
 
-        MACAddressParser const & operator= (value_type const & other) { value(other); return *this; }
+        using Base::operator=;
     };
-    
+
     /** \brief Parse an Ethernet packet
 
         Parser implementing an ethernet header.
@@ -80,7 +78,7 @@ namespace senf {
     /** \brief EtherType registry
 
         This registry registers packet types with their EtherType number.
-        
+
         \see <a href="http://www.iana.org/assignments/ethernet-numbers">Ethernet numbers</a> \n
             \ref PacketRegistry
      */
@@ -121,15 +119,18 @@ namespace senf {
 
         static factory_t nextPacketType(packet p);
         /// Dump given EthernetPacket in readable form to given output stream
-        static void dump(packet p, std::ostream & os); 
+        static void dump(packet p, std::ostream & os);
         static void finalize(packet p);
     };
 
-    /** \brief Ethernet packet typedef */
+    /** \brief Ethernet packet typedef
+        \ingroup protocolbundle_default
+     */
     typedef ConcretePacket<EthernetPacketType> EthernetPacket;
 
+
     /** \brief Parse an ethernet VLAN tag
-        
+
         Parser interpreting the ethernet VLAN tag. Fields are
 
         \see EthVLanPacketType
@@ -155,7 +156,7 @@ namespace senf {
         \par Fields:
             \ref EthVLanPacketParser
             \image html EthVLanPacket.png
-        
+
         \par Associated registries:
             \ref EtherTypes
 
@@ -165,7 +166,7 @@ namespace senf {
         \ingroup protocolbundle_default
      */
     struct EthVLanPacketType
-        : public PacketTypeBase, 
+        : public PacketTypeBase,
           public PacketTypeMixin<EthVLanPacketType, EtherTypes>
     {
 #ifndef DOXYGEN
@@ -181,7 +182,7 @@ namespace senf {
 
         /** \todo Add LLC/SNAP support -> only use the registry
             for type() values >=1536, otherwise expect an LLC header */
-        static key_t nextPacketKey(packet p) 
+        static key_t nextPacketKey(packet p)
             { return p->type(); }
 
         /// Dump given EthVLanPacket in readable form to given output stream
@@ -189,12 +190,14 @@ namespace senf {
         static void finalize(packet p);
     };
 
-    /** \brief Ethernet VLAN tag typedef */
+    /** \brief Ethernet VLAN tag typedef
+        \ingroup protocolbundle_default
+     */
     typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "EthernetPacket.cci"
 //#include "EthernetPacket.ct"
 //#include "EthernetPacket.cti"