X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FPackets%2FDefaultBundle%2FEthernetPacket.hh;h=b38edfc0ffd79676ffc6dfc13187f200e83a6464;hb=cad7256a15fbec9b4bf38559e89db7e0fe814db0;hp=70c769d2c1efde40b4a0d23750c76e80c66340fa;hpb=26610f603ebdd465307b9621f532c1fe19fd5571;p=senf.git
diff --git a/senf/Packets/DefaultBundle/EthernetPacket.hh b/senf/Packets/DefaultBundle/EthernetPacket.hh
index 70c769d..b38edfc 100644
--- a/senf/Packets/DefaultBundle/EthernetPacket.hh
+++ b/senf/Packets/DefaultBundle/EthernetPacket.hh
@@ -36,7 +36,7 @@
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
@@ -46,7 +46,7 @@ namespace senf {
struct MACAddressParser : public PacketParserBase
{
MACAddressParser(data_iterator i, state_type s) : PacketParserBase(i,s,fixed_bytes) {}
-
+
///////////////////////////////////////////////////////////////////////////
typedef MACAddress value_type;
@@ -59,7 +59,7 @@ namespace senf {
MACAddressParser const & operator= (value_type const & other) { value(other); return *this; }
};
-
+
/** \brief Parse an Ethernet packet
Parser implementing an ethernet header.
@@ -80,7 +80,7 @@ namespace senf {
/** \brief EtherType registry
This registry registers packet types with their EtherType number.
-
+
\see Ethernet numbers \n
\ref PacketRegistry
*/
@@ -121,15 +121,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 EthernetPacket;
+
/** \brief Parse an ethernet VLAN tag
-
+
Parser interpreting the ethernet VLAN tag. Fields are
\see EthVLanPacketType
@@ -155,7 +158,7 @@ namespace senf {
\par Fields:
\ref EthVLanPacketParser
\image html EthVLanPacket.png
-
+
\par Associated registries:
\ref EtherTypes
@@ -165,7 +168,7 @@ namespace senf {
\ingroup protocolbundle_default
*/
struct EthVLanPacketType
- : public PacketTypeBase,
+ : public PacketTypeBase,
public PacketTypeMixin
{
#ifndef DOXYGEN
@@ -181,7 +184,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,7 +192,9 @@ namespace senf {
static void finalize(packet p);
};
- /** \brief Ethernet VLAN tag typedef */
+ /** \brief Ethernet VLAN tag typedef
+ \ingroup protocolbundle_default
+ */
typedef ConcretePacket EthVLanPacket;
}