ns3::Icmpv4DestinationUnreachable Class Reference

#include <icmpv4.h>

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

List of all members.

Public Types

enum  {
  NET_UNREACHABLE = 0, HOST_UNREACHABLE = 1, PROTOCOL_UNREACHABLE = 2, PORT_UNREACHABLE = 3,
  FRAG_NEEDED = 4, SOURCE_ROUTE_FAILED = 5
}

Public Member Functions

 Icmpv4DestinationUnreachable ()
virtual ~Icmpv4DestinationUnreachable ()
void SetNextHopMtu (uint16_t mtu)
uint16_t GetNextHopMtu (void) const
void SetData (Ptr< const Packet > data)
void SetHeader (Ipv4Header header)
void GetData (uint8_t payload[8]) const
Ipv4Header GetHeader (void) const

Static Public Member Functions

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

Private Member Functions

virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)
virtual void Print (std::ostream &os) const

Private Attributes

uint16_t m_nextHopMtu
Ipv4Header m_header
uint8_t m_data [8]

Detailed Description

Definition at line 70 of file icmpv4.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
NET_UNREACHABLE 
HOST_UNREACHABLE 
PROTOCOL_UNREACHABLE 
PORT_UNREACHABLE 
FRAG_NEEDED 
SOURCE_ROUTE_FAILED 

Definition at line 73 of file icmpv4.h.


Constructor & Destructor Documentation

ns3::Icmpv4DestinationUnreachable::Icmpv4DestinationUnreachable (  ) 

Definition at line 196 of file icmpv4.cc.

References m_data.

ns3::Icmpv4DestinationUnreachable::~Icmpv4DestinationUnreachable (  )  [virtual]

Definition at line 239 of file icmpv4.cc.


Member Function Documentation

uint32_t ns3::Icmpv4DestinationUnreachable::Deserialize ( Buffer::Iterator  start  )  [private, 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 263 of file icmpv4.cc.

References ns3::Ipv4Header::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_data, m_header, m_nextHopMtu, ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::ReadNtohU16(), and ns3::Buffer::Iterator::ReadU8().

void ns3::Icmpv4DestinationUnreachable::GetData ( uint8_t  payload[8]  )  const

Definition at line 228 of file icmpv4.cc.

References m_data.

Ipv4Header ns3::Icmpv4DestinationUnreachable::GetHeader ( void   )  const

Definition at line 233 of file icmpv4.cc.

References m_header.

TypeId ns3::Icmpv4DestinationUnreachable::GetInstanceTypeId ( void   )  const [private, 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 242 of file icmpv4.cc.

References GetTypeId().

uint16_t ns3::Icmpv4DestinationUnreachable::GetNextHopMtu ( void   )  const

Definition at line 212 of file icmpv4.cc.

References m_nextHopMtu.

uint32_t ns3::Icmpv4DestinationUnreachable::GetSerializedSize ( void   )  const [private, 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 247 of file icmpv4.cc.

References ns3::Ipv4Header::GetSerializedSize(), and m_header.

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

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

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

Reimplemented from ns3::Header.

Definition at line 188 of file icmpv4.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::Icmpv4DestinationUnreachable::Print ( std::ostream &  os  )  const [private, 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 277 of file icmpv4.cc.

References m_data, m_header, and ns3::Ipv4Header::Print().

void ns3::Icmpv4DestinationUnreachable::Serialize ( Buffer::Iterator  start  )  const [private, 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 252 of file icmpv4.cc.

References ns3::Ipv4Header::GetSerializedSize(), m_data, m_header, m_nextHopMtu, ns3::Buffer::Iterator::Next(), ns3::Ipv4Header::Serialize(), ns3::Buffer::Iterator::Write(), ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU16().

void ns3::Icmpv4DestinationUnreachable::SetData ( Ptr< const Packet data  ) 

Definition at line 218 of file icmpv4.cc.

References m_data.

void ns3::Icmpv4DestinationUnreachable::SetHeader ( Ipv4Header  header  ) 

Definition at line 223 of file icmpv4.cc.

References m_header.

void ns3::Icmpv4DestinationUnreachable::SetNextHopMtu ( uint16_t  mtu  ) 

Definition at line 207 of file icmpv4.cc.

References m_nextHopMtu.


Member Data Documentation

Definition at line 103 of file icmpv4.h.

Referenced by Deserialize(), GetData(), Icmpv4DestinationUnreachable(), Print(), Serialize(), and SetData().

Definition at line 102 of file icmpv4.h.

Referenced by Deserialize(), GetHeader(), GetSerializedSize(), Print(), Serialize(), and SetHeader().

Definition at line 101 of file icmpv4.h.

Referenced by Deserialize(), GetNextHopMtu(), Serialize(), and SetNextHopMtu().


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