ns3::ArpHeader Class Reference
[Arp]

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

#include <arp-header.h>

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

List of all members.

Public Types

enum  ArpType_e { ARP_TYPE_REQUEST = 1, ARP_TYPE_REPLY = 2 }

Public Member Functions

void SetRequest (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
void SetReply (Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
bool IsRequest (void) const
bool IsReply (void) const
Address GetSourceHardwareAddress (void)
Address GetDestinationHardwareAddress (void)
Ipv4Address GetSourceIpv4Address (void)
Ipv4Address GetDestinationIpv4Address (void)
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::ArpHeader.

Public Attributes

uint16_t m_type
Address m_macSource
Address m_macDest
Ipv4Address m_ipv4Source
Ipv4Address m_ipv4Dest

Detailed Description

The packet header for an ARP packet.

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


Member Enumeration Documentation

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

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

Address ns3::ArpHeader::GetDestinationHardwareAddress ( void   ) 

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

References m_macDest.

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

Ipv4Address ns3::ArpHeader::GetDestinationIpv4Address ( void   ) 

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

References m_ipv4Dest.

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

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

References GetTypeId().

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

Referenced by Deserialize().

Address ns3::ArpHeader::GetSourceHardwareAddress ( void   ) 

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

References m_macSource.

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

Ipv4Address ns3::ArpHeader::GetSourceIpv4Address ( void   ) 

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

References m_ipv4Source.

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

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

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

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

Reimplemented from ns3::Header.

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

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

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

References ARP_TYPE_REPLY, and m_type.

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

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

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

References ARP_TYPE_REQUEST, and m_type.

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

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

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

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

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

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

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

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

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

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

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

Member Data Documentation

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

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

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

Referenced by Deserialize(), IsReply(), IsRequest(), Serialize(), SetReply(), and SetRequest().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:36 2009 for NS-3 by  doxygen 1.6.3