The packet header for an ARP packet. More...

#include <arp-header.h>

Inheritance diagram for ns3::ArpHeader:

Collaboration diagram for ns3::ArpHeader:

Public Types
enum	ArpType_e { ARP_TYPE_REQUEST = 1, ARP_TYPE_REPLY = 2 }

Public Member Functions
virtual uint32_t	Deserialize (Buffer::Iterator start)
Address	GetDestinationHardwareAddress (void)
Ipv4Address	GetDestinationIpv4Address (void)
virtual TypeId	GetInstanceTypeId (void) const
virtual uint32_t	GetSerializedSize (void) const
Address	GetSourceHardwareAddress (void)
Ipv4Address	GetSourceIpv4Address (void)
bool	IsReply (void) const
bool	IsRequest (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (Buffer::Iterator start) const
void	SetReply (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
void	SetRequest (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
Public Member Functions inherited from ns3::Header
virtual	~Header ()

Static Public Member Functions
static TypeId	GetTypeId (void)

Public Attributes
Ipv4Address	m_ipv4Dest
Ipv4Address	m_ipv4Source
Address	m_macDest
Address	m_macSource
uint16_t	m_type

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

The packet header for an ARP packet.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 34 of file arp-header.h.

Member Enumeration Documentation

enum ns3::ArpHeader::ArpType_e

Enumerator:

ARP_TYPE_REQUEST
ARP_TYPE_REPLY

Definition at line 59 of file arp-header.h.

Member Function Documentation

uint32_t ns3::ArpHeader::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.

Definition at line 168 of file arp-header.cc.

References GetSerializedSize(), m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

Address ns3::ArpHeader::GetDestinationHardwareAddress ( void )

Definition at line 77 of file arp-header.cc.

References m_macDest, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

Ipv4Address ns3::ArpHeader::GetDestinationIpv4Address ( void )

Definition at line 89 of file arp-header.cc.

References m_ipv4Dest, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

TypeId ns3::ArpHeader::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.

Definition at line 106 of file arp-header.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

uint32_t ns3::ArpHeader::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.

Definition at line 135 of file arp-header.cc.

References ns3::Address::GetLength(), m_macDest, m_macSource, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Address ns3::ArpHeader::GetSourceHardwareAddress ( void )

Definition at line 71 of file arp-header.cc.

References m_macSource, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

Ipv4Address ns3::ArpHeader::GetSourceIpv4Address ( void )

Definition at line 83 of file arp-header.cc.

References m_ipv4Source, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

TypeId ns3::ArpHeader::GetTypeId ( void )

static

Reimplemented from ns3::Header.

Definition at line 97 of file arp-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::ArpHeader::IsReply ( void ) const

Definition at line 65 of file arp-header.cc.

References ARP_TYPE_REPLY, m_type, and NS_LOG_FUNCTION.

Referenced by Print(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

bool ns3::ArpHeader::IsRequest ( void ) const

Definition at line 59 of file arp-header.cc.

References ARP_TYPE_REQUEST, m_type, and NS_LOG_FUNCTION.

Referenced by Print(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

void ns3::ArpHeader::Print ( std::ostream & os ) const

virtual

Parameters

os output stream 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.

Definition at line 112 of file arp-header.cc.

References IsReply(), IsRequest(), m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::ArpHeader::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.

Definition at line 148 of file arp-header.cc.

References ns3::Address::GetLength(), m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, NS_ASSERT, NS_LOG_FUNCTION, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

void ns3::ArpHeader::SetReply	(	Address	sourceHardwareAddress,
		Ipv4Address	sourceProtocolAddress,
		Address	destinationHardwareAddress,
		Ipv4Address	destinationProtocolAddress
	)

Definition at line 46 of file arp-header.cc.

References ARP_TYPE_REPLY, m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, and NS_LOG_FUNCTION.

Referenced by ns3::ArpL3Protocol::SendArpReply().

Here is the caller graph for this function:

void ns3::ArpHeader::SetRequest	(	Address	sourceHardwareAddress,
		Ipv4Address	sourceProtocolAddress,
		Address	destinationHardwareAddress,
		Ipv4Address	destinationProtocolAddress
	)