The packet header for an ARP packet. More...
#include "arp-header.h"
Public Types | |
enum | ArpType_e { ARP_TYPE_REQUEST = 1 , ARP_TYPE_REPLY = 2 } |
Enumeration listing the possible ARP types. More... | |
Public Member Functions | |
uint32_t | Deserialize (Buffer::Iterator start) override |
Address | GetDestinationHardwareAddress () const |
Returns the destination hardware address. | |
Ipv4Address | GetDestinationIpv4Address () const |
Returns the destination IP address. | |
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 | |
Ipv4Address | m_ipv4Dest |
IP destination address. | |
Ipv4Address | m_ipv4Source |
IP source address. | |
Address | m_macDest |
hardware destination address | |
Address | m_macSource |
hardware source address | |
uint16_t | m_type |
type of the ICMP (ARP_TYPE_REQUEST) | |
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. | |
The packet header for an ARP packet.
Definition at line 24 of file arp-header.h.
Enumeration listing the possible ARP types.
Enumerator | |
---|---|
ARP_TYPE_REQUEST | |
ARP_TYPE_REPLY |
Definition at line 102 of file arp-header.h.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 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(), and ns3::Buffer::Iterator::ReadU8().
Address ns3::ArpHeader::GetDestinationHardwareAddress | ( | ) | const |
Returns the destination hardware address.
Definition at line 74 of file arp-header.cc.
References m_macDest, and NS_LOG_FUNCTION.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().
Ipv4Address ns3::ArpHeader::GetDestinationIpv4Address | ( | ) | const |
Returns the destination IP address.
Definition at line 88 of file arp-header.cc.
References m_ipv4Dest, and NS_LOG_FUNCTION.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().
|
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.
Implements ns3::ObjectBase.
Definition at line 105 of file arp-header.cc.
References GetTypeId(), and NS_LOG_FUNCTION.
|
overridevirtual |
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 134 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().
Address ns3::ArpHeader::GetSourceHardwareAddress | ( | ) | const |
Returns the source hardware address.
Definition at line 67 of file arp-header.cc.
References m_macSource, and NS_LOG_FUNCTION.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().
Ipv4Address ns3::ArpHeader::GetSourceIpv4Address | ( | ) | const |
Returns the source IP address.
Definition at line 81 of file arp-header.cc.
References m_ipv4Source, and NS_LOG_FUNCTION.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::ArpQueueDiscItem::Hash(), and ns3::ArpL3Protocol::Receive().
|
static |
Get the type ID.
Definition at line 95 of file arp-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
bool ns3::ArpHeader::IsReply | ( | ) | const |
Check if the ARP is a reply.
Definition at line 60 of file arp-header.cc.
References ARP_TYPE_REPLY, m_type, and NS_LOG_FUNCTION.
Referenced by Print(), and ns3::ArpL3Protocol::Receive().
bool ns3::ArpHeader::IsRequest | ( | ) | const |
Check if the ARP is a request.
Definition at line 53 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().
|
overridevirtual |
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 112 of file arp-header.cc.
References IsReply(), IsRequest(), m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, NS_ASSERT, and NS_LOG_FUNCTION.
|
overridevirtual |
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, ns3::Buffer::Iterator::WriteHtonU16(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().
void ns3::ArpHeader::SetReply | ( | Address | sourceHardwareAddress, |
Ipv4Address | sourceProtocolAddress, | ||
Address | destinationHardwareAddress, | ||
Ipv4Address | destinationProtocolAddress ) |
Set the ARP reply 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 38 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().
void ns3::ArpHeader::SetRequest | ( | Address | sourceHardwareAddress, |
Ipv4Address | sourceProtocolAddress, | ||
Address | destinationHardwareAddress, | ||
Ipv4Address | destinationProtocolAddress ) |
Set the ARP request 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, m_ipv4Dest, m_ipv4Source, m_macDest, m_macSource, m_type, and NS_LOG_FUNCTION.
Referenced by ns3::ArpL3Protocol::SendArpRequest().
Ipv4Address ns3::ArpHeader::m_ipv4Dest |
IP destination address.
Definition at line 112 of file arp-header.h.
Referenced by Deserialize(), GetDestinationIpv4Address(), Print(), Serialize(), SetReply(), and SetRequest().
Ipv4Address ns3::ArpHeader::m_ipv4Source |
IP source address.
Definition at line 111 of file arp-header.h.
Referenced by Deserialize(), GetSourceIpv4Address(), Print(), Serialize(), SetReply(), and SetRequest().
Address ns3::ArpHeader::m_macDest |
hardware destination address
Definition at line 110 of file arp-header.h.
Referenced by Deserialize(), GetDestinationHardwareAddress(), GetSerializedSize(), Print(), Serialize(), SetReply(), and SetRequest().
Address ns3::ArpHeader::m_macSource |
hardware source address
Definition at line 109 of file arp-header.h.
Referenced by Deserialize(), GetSerializedSize(), GetSourceHardwareAddress(), Print(), Serialize(), SetReply(), and SetRequest().
uint16_t ns3::ArpHeader::m_type |
type of the ICMP (ARP_TYPE_REQUEST)
Definition at line 108 of file arp-header.h.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), Deserialize(), IsReply(), IsRequest(), Serialize(), SetReply(), and SetRequest().