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 : uint16_t { ARP_TYPE_REQUEST = 1 , ARP_TYPE_REPLY = 2 }
	Enumeration listing the possible ARP types. More...

enum class	HardwareType : uint16_t { UNKNOWN = 0 , ETHERNET = 1 , EUI_64 = 27 }
	Enumeration listing the supported hardware types. More...

Public Member Functions
uint32_t	Deserialize (Buffer::Iterator start) override

HardwareType	DetermineHardwareType (const Address &address) const
	Determines the hardware type based on the length of the address.

Address	GetDestinationHardwareAddress () const
	Returns the destination hardware address.

Ipv4Address	GetDestinationIpv4Address () const
	Returns the destination IP address.

HardwareType	GetHardwareType () const
	Get the hardware type.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetSerializedSize () const override

Address	GetSourceHardwareAddress () const
	Returns the source hardware address.

Ipv4Address	GetSourceIpv4Address () const
	Returns the source IP address.

bool	IsReply () const
	Check if the ARP is a reply.

bool	IsRequest () const
	Check if the ARP is a request.

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetReply (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
	Set the ARP reply parameters.

void	SetRequest (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
	Set the ARP request parameters.

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Public Attributes
HardwareType	m_hardwareType
	hardware type

Ipv4Address	m_ipv4Dest
	IP destination address.

Ipv4Address	m_ipv4Source
	IP source address.

Address	m_macDest
	hardware destination address

Address	m_macSource
	hardware source address

ArpType_e	m_type
	type of the ICMP packet

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

The packet header for an ARP packet.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet

Size of this type is 72 bytes (on a 64-bit architecture).

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

Member Enumeration Documentation

◆ ArpType_e

enum ns3::ArpHeader::ArpType_e : uint16_t

Enumeration listing the possible ARP types.

These ARP types are part of the standard ARP packet format as defined in Section "Definitions" of RFC 826 .

Enumerator
ARP_TYPE_REQUEST
ARP_TYPE_REPLY

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

◆ HardwareType

enum class ns3::ArpHeader::HardwareType : uint16_t

strong

Enumeration listing the supported hardware types.

RFC 826 specifies that the Hardware Type field in the ARP packet indicates the type of hardware used. For the full list of Hardware Types, refer to: https://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml

Enumerator
UNKNOWN
ETHERNET
EUI_64

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::ArpHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

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.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

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

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

Here is the call graph for this function:

◆ DetermineHardwareType()

ArpHeader::HardwareType ns3::ArpHeader::DetermineHardwareType ( const Address & address ) const

Determines the hardware type based on the length of the address.

This method determines the hardware type based on the length of the address. It supports two common hardware address lengths:

6 bytes: Assumed to be Ethernet.
8 bytes: Assumed to be EUI-64.

If the length of the address does not match these common lengths, the method defaults to Unknown hardware type.

Parameters

address The address whose length is used to determine the hardware type.

Returns: The corresponding hardware type.

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

References ETHERNET, EUI_64, NS_LOG_FUNCTION, and UNKNOWN.

Referenced by SetReply(), and SetRequest().

Here is the caller graph for this function:

◆ GetDestinationHardwareAddress()

Address ns3::ArpHeader::GetDestinationHardwareAddress ( ) const

Returns the destination hardware address.

Returns: the destination hardware address

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

References m_macDest, and NS_LOG_FUNCTION.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

◆ GetDestinationIpv4Address()

Ipv4Address ns3::ArpHeader::GetDestinationIpv4Address ( ) const

Returns the destination IP address.

Returns: the destination IP address

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

References m_ipv4Dest, and NS_LOG_FUNCTION.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

◆ GetHardwareType()

ArpHeader::HardwareType ns3::ArpHeader::GetHardwareType ( ) const

Get the hardware type.

Returns: the hardware type

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

References m_hardwareType, and NS_LOG_FUNCTION.

Referenced by Print().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::ArpHeader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

References GetTypeId(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::ArpHeader::GetSerializedSize ( ) const

overridevirtual

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 161 of file arp-header.cc.

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

Referenced by Deserialize(), and ns3::ArpQueueDiscItem::GetSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSourceHardwareAddress()

Address ns3::ArpHeader::GetSourceHardwareAddress ( ) const

Returns the source hardware address.

Returns: the source hardware address

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

References m_macSource, and NS_LOG_FUNCTION.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

◆ GetSourceIpv4Address()

Ipv4Address ns3::ArpHeader::GetSourceIpv4Address ( ) const

Returns the source IP address.

Returns: the source IP address

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

References m_ipv4Source, and NS_LOG_FUNCTION.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ArpHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 120 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:

◆ IsReply()

bool ns3::ArpHeader::IsReply ( ) const

Check if the ARP is a reply.

Returns: true if it is a reply

Definition at line 78 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:

◆ IsRequest()

bool ns3::ArpHeader::IsRequest ( ) const

Check if the ARP is a request.

Returns: true if it is a request

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

References ARP_TYPE_REQUEST, m_type, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ Print()

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

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header 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 137 of file arp-header.cc.

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

Here is the call graph for this function:

◆ Serialize()

void ns3::ArpHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

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 175 of file arp-header.cc.

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

Here is the call graph for this function:

◆ SetReply()

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

Set the ARP reply parameters.

Parameters

sourceHardwareAddress	the source hardware address
sourceProtocolAddress	the source IP address
destinationHardwareAddress	the destination hardware address (usually the broadcast address)
destinationProtocolAddress	the destination IP address

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

References ARP_TYPE_REPLY, DetermineHardwareType(), m_hardwareType, m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRequest()

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

Set the ARP request parameters.

Parameters

sourceHardwareAddress	the source hardware address
sourceProtocolAddress	the source IP address
destinationHardwareAddress	the destination hardware address (usually the broadcast address)
destinationProtocolAddress	the destination IP address

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

References ARP_TYPE_REQUEST, DetermineHardwareType(), m_hardwareType, m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_hardwareType

HardwareType ns3::ArpHeader::m_hardwareType

hardware type

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

Referenced by Deserialize(), GetHardwareType(), Serialize(), SetReply(), and SetRequest().

◆ m_ipv4Dest

Ipv4Address ns3::ArpHeader::m_ipv4Dest

IP destination address.

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

Referenced by Deserialize(), GetDestinationIpv4Address(), Print(), Serialize(), SetReply(), and SetRequest().

◆ m_ipv4Source

Ipv4Address ns3::ArpHeader::m_ipv4Source

IP source address.

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

Referenced by Deserialize(), GetSourceIpv4Address(), Print(), Serialize(), SetReply(), and SetRequest().

◆ m_macDest

Address ns3::ArpHeader::m_macDest

hardware destination address

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

Referenced by Deserialize(), GetDestinationHardwareAddress(), GetSerializedSize(), Print(), Serialize(), SetReply(), and SetRequest().

◆ m_macSource

Address ns3::ArpHeader::m_macSource

hardware source address

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

Referenced by Deserialize(), GetSerializedSize(), GetSourceHardwareAddress(), Print(), Serialize(), SetReply(), and SetRequest().

◆ m_type

ArpType_e ns3::ArpHeader::m_type

type of the ICMP packet

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

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), Deserialize(), IsReply(), IsRequest(), Serialize(), SetReply(), and SetRequest().

The documentation for this class was generated from the following files:

src/internet/model/arp-header.h
src/internet/model/arp-header.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ArpType_e

◆ HardwareType

Member Function Documentation

◆ Deserialize()

◆ DetermineHardwareType()

◆ GetDestinationHardwareAddress()

◆ GetDestinationIpv4Address()

◆ GetHardwareType()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetSourceHardwareAddress()

◆ GetSourceIpv4Address()

◆ GetTypeId()

◆ IsReply()

◆ IsRequest()

◆ Print()

◆ Serialize()

◆ SetReply()

◆ SetRequest()

Member Data Documentation

◆ m_hardwareType

◆ m_ipv4Dest

◆ m_ipv4Source

◆ m_macDest

◆ m_macSource

◆ m_type