ns3::Icmpv4TimeExceeded Class Reference

#include <icmpv4.h>

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

List of all members.

Public Types

enum  { TIME_TO_LIVE = 0, FRAGMENT_REASSEMBLY = 1 }

Public Member Functions

void SetData (Ptr< const Packet > data)
void SetHeader (Ipv4Header header)
void GetData (uint8_t payload[8]) const
Ipv4Header GetHeader (void) const
 Icmpv4TimeExceeded ()
virtual ~Icmpv4TimeExceeded ()
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

Static Public Member Functions

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

Private Attributes

Ipv4Header m_header
uint8_t m_data [8]

Detailed Description

Definition at line 107 of file icmpv4.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
TIME_TO_LIVE 
FRAGMENT_REASSEMBLY 

Definition at line 110 of file icmpv4.h.


Constructor & Destructor Documentation

ns3::Icmpv4TimeExceeded::Icmpv4TimeExceeded (  ) 

Definition at line 304 of file icmpv4.cc.

References m_data.

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

Definition at line 337 of file icmpv4.cc.


Member Function Documentation

uint32_t ns3::Icmpv4TimeExceeded::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 360 of file icmpv4.cc.

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

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

Definition at line 326 of file icmpv4.cc.

References m_data.

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

Definition at line 331 of file icmpv4.cc.

References m_header.

TypeId ns3::Icmpv4TimeExceeded::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 340 of file icmpv4.cc.

References GetTypeId().

uint32_t ns3::Icmpv4TimeExceeded::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 345 of file icmpv4.cc.

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

TypeId ns3::Icmpv4TimeExceeded::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 296 of file icmpv4.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::Icmpv4TimeExceeded::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 373 of file icmpv4.cc.

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

void ns3::Icmpv4TimeExceeded::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 350 of file icmpv4.cc.

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

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

Definition at line 316 of file icmpv4.cc.

References m_data.

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

Definition at line 321 of file icmpv4.cc.

References m_header.


Member Data Documentation

uint8_t ns3::Icmpv4TimeExceeded::m_data[8] [private]

Definition at line 132 of file icmpv4.h.

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

Definition at line 131 of file icmpv4.h.

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


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