A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Icmpv4DestinationUnreachable Class Reference

Doxygen introspection did not find any typical Config paths. More...

#include <icmpv4.h>

+ Inheritance diagram for ns3::Icmpv4DestinationUnreachable:
+ Collaboration diagram for ns3::Icmpv4DestinationUnreachable:

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 GetData (uint8_t payload[8]) const
 Get the ICMP carried data. More...
 
Ipv4Header GetHeader (void) const
 Get the ICMP carried IPv4 header. More...
 
uint16_t GetNextHopMtu (void) const
 Get the next hop MTU. More...
 
void SetData (Ptr< const Packet > data)
 Set the ICMP carried data. More...
 
void SetHeader (Ipv4Header header)
 Set the ICMP carried IPv4 header. More...
 
void SetNextHopMtu (uint16_t mtu)
 Set the next hop MTU. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

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

Private Member Functions

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

Private Attributes

uint8_t m_data [8]
 carried data More...
 
Ipv4Header m_header
 carried IPv4 header More...
 
uint16_t m_nextHopMtu
 next hop MTU More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Doxygen introspection did not find any typical Config paths.


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

Definition at line 151 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 154 of file icmpv4.h.

Constructor & Destructor Documentation

ns3::Icmpv4DestinationUnreachable::Icmpv4DestinationUnreachable ( )

Definition at line 287 of file icmpv4.cc.

References m_data, and NS_LOG_FUNCTION.

ns3::Icmpv4DestinationUnreachable::~Icmpv4DestinationUnreachable ( )
virtual

Definition at line 337 of file icmpv4.cc.

Member Function Documentation

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

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

+ Here is the call graph for this function:

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

Get the ICMP carried data.

Parameters
payloadthe data (filled)

Definition at line 324 of file icmpv4.cc.

References m_data, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

Get the ICMP carried IPv4 header.

Returns
the header

Definition at line 330 of file icmpv4.cc.

References m_header, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

TypeId ns3::Icmpv4DestinationUnreachable::GetInstanceTypeId ( void  ) const
privatevirtual
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 341 of file icmpv4.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

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

Get the next hop MTU.

Returns
the MTU

Definition at line 305 of file icmpv4.cc.

References m_nextHopMtu, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

uint32_t ns3::Icmpv4DestinationUnreachable::GetSerializedSize ( void  ) const
privatevirtual
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 347 of file icmpv4.cc.

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

+ Here is the call graph for this function:

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

Get ICMP type.

Returns
the ICMP type

Definition at line 279 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:

void ns3::Icmpv4DestinationUnreachable::Print ( std::ostream &  os) const
privatevirtual
Parameters
osoutput stream 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 380 of file icmpv4.cc.

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

+ Here is the call graph for this function:

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

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

+ Here is the call graph for this function:

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

Set the ICMP carried data.

Parameters
datathe data

Definition at line 312 of file icmpv4.cc.

References ns3::Packet::CopyData(), m_data, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

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

Set the ICMP carried IPv4 header.

Parameters
headerthe header

Definition at line 318 of file icmpv4.cc.

References m_header, and NS_LOG_FUNCTION.

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

Set the next hop MTU.

Parameters
mtuthe MTU

Definition at line 299 of file icmpv4.cc.

References m_nextHopMtu, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

Member Data Documentation

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

carried data

Definition at line 213 of file icmpv4.h.

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

Ipv4Header ns3::Icmpv4DestinationUnreachable::m_header
private

carried IPv4 header

Definition at line 212 of file icmpv4.h.

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

uint16_t ns3::Icmpv4DestinationUnreachable::m_nextHopMtu
private

next hop MTU

Definition at line 211 of file icmpv4.h.

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


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