A Discrete-Event Network Simulator
API

ICMP Time Exceeded header. More...

#include "icmpv4.h"

+ Inheritance diagram for ns3::Icmpv4TimeExceeded:
+ Collaboration diagram for ns3::Icmpv4TimeExceeded:

Public Types

enum  ErrorTimeExceeded_e { ICMPV4_TIME_TO_LIVE = 0 , ICMPV4_FRAGMENT_REASSEMBLY = 1 }
 ICMP error code : Time Exceeded. More...
 

Public Member Functions

 Icmpv4TimeExceeded ()
 
virtual ~Icmpv4TimeExceeded ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
void GetData (uint8_t payload[8]) const
 Get the ICMP carried data. More...
 
Ipv4Header GetHeader (void) const
 Get the ICMP carried IPv4 header. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetData (Ptr< const Packet > data)
 Get the ICMP carried data. More...
 
void SetHeader (Ipv4Header header)
 Set the ICMP carried IPv4 header. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get ICMP type. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_data [8]
 carried data More...
 
Ipv4Header m_header
 carried IPv4 header More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

ICMP Time Exceeded header.

Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 64 bytes (on a 64-bit architecture).

Definition at line 246 of file icmpv4.h.

Member Enumeration Documentation

◆ ErrorTimeExceeded_e

ICMP error code : Time Exceeded.

Enumerator
ICMPV4_TIME_TO_LIVE 
ICMPV4_FRAGMENT_REASSEMBLY 

Definition at line 252 of file icmpv4.h.

Constructor & Destructor Documentation

◆ Icmpv4TimeExceeded()

ns3::Icmpv4TimeExceeded::Icmpv4TimeExceeded ( )

Definition at line 413 of file icmpv4.cc.

References m_data, and NS_LOG_FUNCTION.

◆ ~Icmpv4TimeExceeded()

ns3::Icmpv4TimeExceeded::~Icmpv4TimeExceeded ( )
virtual

Definition at line 451 of file icmpv4.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::Icmpv4TimeExceeded::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 479 of file icmpv4.cc.

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

+ Here is the call graph for this function:

◆ GetData()

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

Get the ICMP carried data.

Parameters
payloadthe data (filled)

Definition at line 438 of file icmpv4.cc.

References m_data, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv4L4Protocol::HandleTimeExceeded(), and ns3::V4TraceRoute::Receive().

+ Here is the caller graph for this function:

◆ GetHeader()

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

Get the ICMP carried IPv4 header.

Returns
the header

Definition at line 444 of file icmpv4.cc.

References m_header, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv4L4Protocol::HandleTimeExceeded().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Icmpv4TimeExceeded::GetInstanceTypeId ( void  ) const
virtual

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 456 of file icmpv4.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetSerializedSize()

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 462 of file icmpv4.cc.

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

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::Icmpv4TimeExceeded::GetTypeId ( void  )
static

Get ICMP type.

Returns
the ICMP type

Definition at line 404 of file icmpv4.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Print()

void ns3::Icmpv4TimeExceeded::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 493 of file icmpv4.cc.

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

+ Here is the call graph for this function:

◆ Serialize()

void ns3::Icmpv4TimeExceeded::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 468 of file icmpv4.cc.

References ns3::Ipv4Header::GetSerializedSize(), m_data, m_header, NS_LOG_FUNCTION, ns3::Ipv4Header::Serialize(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetData()

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

Get the ICMP carried data.

Parameters
datathe data

Definition at line 426 of file icmpv4.cc.

References data, m_data, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv4L4Protocol::SendTimeExceededTtl().

+ Here is the caller graph for this function:

◆ SetHeader()

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

Set the ICMP carried IPv4 header.

Parameters
headerthe header

Definition at line 432 of file icmpv4.cc.

References m_header, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv4L4Protocol::SendTimeExceededTtl().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_data

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

carried data

Definition at line 295 of file icmpv4.h.

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

◆ m_header

Ipv4Header ns3::Icmpv4TimeExceeded::m_header
private

carried IPv4 header

Definition at line 294 of file icmpv4.h.

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


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