-// $id: EthernetPacket.hh 299 2007-07-10 21:23:49Z g0dil $
+// $Id$
//
// Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// 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
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+/** \file
+ \brief EthernetPacket public header */
+
#ifndef HH_EthernetPacket_
#define HH_EthernetPacket_ 1
// Custom includes
#include <algorithm>
-#include <boost/array.hpp>
-#include "Packets/Packets.hh"
+#include "../../Socket/Protocols/Raw/MACAddress.hh"
+#include "../../Packets/Packets.hh"
//#include "EthernetPacket.mpp"
///////////////////////////////hh.p////////////////////////////////////////
namespace senf {
- ///\addtogroup protocolbundle_default
- ///@{
-
- struct MACAddress
- : boost::array<PacketParserBase::byte,6>
- {
- MACAddress(std::string addr);
- template <class InputIterator>
- MACAddress(InputIterator i);
+ /** \brief Parse an Ethernet MAC address
- struct SyntaxException : public std::exception
- { virtual char const * what() const throw() { return "invalid mac address syntax"; } };
- };
+ The ethernet MAC is returned by value as a 6-byte sequence
- struct Parse_MAC : public PacketParserBase
+ \see MACAddress \n
+ EthernetPacket
+ */
+ struct MACAddressParser : public PacketParserBase
{
- Parse_MAC(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
+ MACAddressParser(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
///////////////////////////////////////////////////////////////////////////
typedef MACAddress value_type;
static const size_type fixed_bytes = 6u;
- value_type value() const { return MACAddress(i()); }
+ 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); }
- Parse_MAC const & operator= (value_type const & other) { value(other); return *this; }
+ MACAddressParser const & operator= (value_type const & other) { value(other); return *this; }
};
+
+ /** \brief Parse an Ethernet packet
- struct Parse_Ethernet : public PacketParserBase
- {
- SENF_PACKET_PARSER_INIT(Parse_Ethernet);
+ Parser implementing an ethernet header.
- ///////////////////////////////////////////////////////////////////////////
+ \see EthernetPacketType
+ */
+ struct EthernetPacketParser : public PacketParserBase
+ {
+# include SENF_FIXED_PARSER()
- typedef Parse_UInt16 Parse_Type;
+ SENF_PARSER_FIELD( destination, MACAddressParser );
+ SENF_PARSER_FIELD( source, MACAddressParser );
+ SENF_PARSER_FIELD( type_length, UInt16Parser );
- SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
- ((Field)( destination, Parse_MAC ))
- ((Field)( source, Parse_MAC ))
- ((Field)( type, Parse_Type )) );
+ SENF_PARSER_FINALIZE(EthernetPacketParser);
};
+ /** \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
+ */
struct EtherTypes {
- // See http://www.iana.org/assignments/ethernet-numbers
+ // See
typedef boost::uint16_t key_t;
};
+ /** \brief Ethernet packet
+
+ \par Packet type (typedef):
+ \ref EthernetPacket
+
+ \par Fields:
+ \ref EthernetPacketParser
+
+ \par Associated registries:
+ \ref EtherTypes
+
+ \par Finalize action:
+ Set \a type from type of next packet if found in \ref EtherTypes
+
+ \ingroup protocolbundle_default
+ */
struct EthernetPacketType
: public PacketTypeBase,
public PacketTypeMixin<EthernetPacketType, EtherTypes>
{
+#ifndef DOXYGEN
typedef PacketTypeMixin<EthernetPacketType, EtherTypes> mixin;
typedef ConcretePacket<EthernetPacketType> packet;
- typedef Parse_Ethernet parser;
-
+ typedef EthernetPacketParser parser;
+#endif
using mixin::nextPacketRange;
- using mixin::nextPacketType;
using mixin::initSize;
using mixin::init;
- /** \todo Add LLC/SNAP support -> only use the registry
- for type() values >=1536, otherwise expect an LLC header */
- static registry_key_t nextPacketKey(packet p)
- { return p->type(); }
-
+ static factory_t nextPacketType(packet p);
static void dump(packet p, std::ostream & os);
+ static void finalize(packet p);
};
- typedef EthernetPacketType::packet EthernetPacket;
+ /** \brief Ethernet packet typedef */
+ typedef ConcretePacket<EthernetPacketType> EthernetPacket;
+
+ /** \brief Parse an ethernet VLAN tag
+
+ Parser interpreting the ethernet VLAN tag. Fields are
- struct Parse_EthVLan : public PacketParserBase
+ \see EthVLanPacketType
+ */
+ struct EthVLanPacketParser : public PacketParserBase
{
- SENF_PACKET_PARSER_INIT(Parse_EthVLan);
+# include SENF_FIXED_PARSER()
- ///////////////////////////////////////////////////////////////////////////
+ SENF_PARSER_BITFIELD( priority, 3, unsigned );
+ SENF_PARSER_BITFIELD( cfi, 1, bool );
+ SENF_PARSER_BITFIELD( vlanId, 12, unsigned );
- typedef Parse_UIntField < 0, 3 > Parse_Priority;
- typedef Parse_Flag < 3 > Parse_CFI;
- typedef Parse_UIntField < 4, 16 > Parse_VLanId;
- typedef Parse_UInt16 Parse_Type;
+ SENF_PARSER_FIELD( type, UInt16Parser );
- SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
- ((OverlayField)( priority, Parse_Priority ))
- ((OverlayField)( cfi, Parse_CFI ))
- ((Field )( vlanId, Parse_VLanId ))
- ((Field )( type, Parse_Type )) );
+ SENF_PARSER_FINALIZE(EthVLanPacketParser);
};
+ /** \brief Ethernet VLAN tag
+
+ \par Packet type (typedef):
+ \ref EthVLanPacket
+
+ \par Fields:
+ \ref EthVLanPacketParser
+
+ \par Associated registries:
+ \ref EtherTypes
+
+ \par Finalize action:
+ Set \a type from type of next packet if found in \ref EtherTypes
+
+ \ingroup protocolbundle_default
+ */
struct EthVLanPacketType
: public PacketTypeBase,
public PacketTypeMixin<EthVLanPacketType, EtherTypes>
{
+#ifndef DOXYGEN
typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
typedef ConcretePacket<EthVLanPacketType> packet;
- typedef Parse_EthVLan parser;
-
+ typedef EthVLanPacketParser parser;
+#endif
using mixin::nextPacketRange;
using mixin::nextPacketType;
using mixin::initSize;
/** \todo Add LLC/SNAP support -> only use the registry
for type() values >=1536, otherwise expect an LLC header */
- static registry_key_t nextPacketKey(packet p)
+ static key_t nextPacketKey(packet p)
{ return p->type(); }
static void dump(packet p, std::ostream & os);
+ static void finalize(packet p);
};
- typedef EthVLanPacketType::packet EthVLanPacket;
+ /** \brief Ethernet VLAN tag typedef */
+ typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
- ///@}
}
-
///////////////////////////////hh.e////////////////////////////////////////
#endif
#ifndef SENF_PACKETS_DECL_ONLY
//#include "EthernetPacket.cci"
-#include "EthernetPacket.ct"
+//#include "EthernetPacket.ct"
//#include "EthernetPacket.cti"
#endif
projects / senf.git / blobdiff