ns3::EthernetHeader Class Reference
[Node]

Packet header for Ethernet. More...

#include <ethernet-header.h>

Inheritance diagram for ns3::EthernetHeader:

Inheritance graph
[legend]
Collaboration diagram for ns3::EthernetHeader:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 EthernetHeader (bool hasPreamble)
 Construct a null ethernet header.
 EthernetHeader ()
 Construct a null ethernet header By default, does not add or remove an ethernet preamble.
void SetLengthType (uint16_t size)
void SetSource (Mac48Address source)
void SetDestination (Mac48Address destination)
void SetPreambleSfd (uint64_t preambleSfd)
uint16_t GetLengthType (void) const
ethernet_header_t GetPacketType (void) const
Mac48Address GetSource (void) const
Mac48Address GetDestination (void) const
uint64_t GetPreambleSfd () const
uint32_t GetHeaderSize () const
virtual TypeId GetInstanceTypeId (void) const
virtual void Print (std::ostream &os) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::EthernetHeader.

Private Attributes

bool m_enPreambleSfd
 size of src/dest addr header fields
uint16_t m_lengthType
 Value of the Preamble/SFD fields.
Mac48Address m_source
 Length or type of the packet.
Mac48Address m_destination
 Source address.

Static Private Attributes

static const int LENGTH_SIZE = 2
 size of the preamble_sfd header field
static const int MAC_ADDR_SIZE = 6
 size of the length_type header field

Detailed Description

Packet header for Ethernet.

This class can be used to add a header to an ethernet packet that will specify the source and destination addresses and the length of the packet. Eventually the class will be improved to also support VLAN tags in packet headers.

Constructor & Destructor Documentation

ns3::EthernetHeader::EthernetHeader ( bool  hasPreamble  ) 

Construct a null ethernet header.

Parameters:
hasPreamble if true, insert and remove an ethernet preamble from the packet, if false, does not insert and remove it.

Member Function Documentation

virtual uint32_t ns3::EthernetHeader::Deserialize ( Buffer::Iterator  start  )  [virtual]

Parameters:
start an iterator which points to where the header should written.
Returns:
the number of bytes read.
This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Header.

Mac48Address ns3::EthernetHeader::GetDestination ( void   )  const

Returns:
The destination address of this packet

uint32_t ns3::EthernetHeader::GetHeaderSize (  )  const

Returns:
The size of the header

virtual TypeId ns3::EthernetHeader::GetInstanceTypeId ( void   )  const [virtual]

Returns:
the TypeId associated to the most-derived type of this instance.
This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

uint16_t ns3::EthernetHeader::GetLengthType ( void   )  const

Returns:
The size of the payload in bytes

ethernet_header_t ns3::EthernetHeader::GetPacketType ( void   )  const

Returns:
The type of packet (only basic Ethernet is currently supported)

uint64_t ns3::EthernetHeader::GetPreambleSfd (  )  const

Returns:
The value of the PreambleSfd field

virtual uint32_t ns3::EthernetHeader::GetSerializedSize ( void   )  const [virtual]

Returns:
the expected size of the header.
This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Mac48Address ns3::EthernetHeader::GetSource ( void   )  const

Returns:
The source address of this packet

static TypeId ns3::EthernetHeader::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::EthernetHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

virtual void ns3::EthernetHeader::Print ( std::ostream &  os  )  const [virtual]

This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

virtual void ns3::EthernetHeader::Serialize ( Buffer::Iterator  start  )  const [virtual]

Parameters:
start an iterator which points to where the header should be written.
This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

void ns3::EthernetHeader::SetDestination ( Mac48Address  destination  ) 

Parameters:
destination The destination address of this packet.

void ns3::EthernetHeader::SetLengthType ( uint16_t  size  ) 

Parameters:
size The size of the payload in bytes

void ns3::EthernetHeader::SetPreambleSfd ( uint64_t  preambleSfd  ) 

Parameters:
preambleSfd The value that the preambleSfd field should take

void ns3::EthernetHeader::SetSource ( Mac48Address  source  ) 

Parameters:
source The source address of this packet

Member Data Documentation

bool ns3::EthernetHeader::m_enPreambleSfd [private]

size of src/dest addr header fields

If false, the preamble/sfd are not serialised/deserialised.

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8