ICMP Destination Unreachable header. More...
#include "icmpv4.h"
Public Types | |
enum | ErrorDestinationUnreachable_e { ICMPV4_NET_UNREACHABLE = 0 , ICMPV4_HOST_UNREACHABLE = 1 , ICMPV4_PROTOCOL_UNREACHABLE = 2 , ICMPV4_PORT_UNREACHABLE = 3 , ICMPV4_FRAG_NEEDED = 4 , ICMPV4_SOURCE_ROUTE_FAILED = 5 } |
ICMP error code : Destination Unreachable. More... | |
Public Member Functions | |
Icmpv4DestinationUnreachable () | |
~Icmpv4DestinationUnreachable () override | |
void | GetData (uint8_t payload[8]) const |
Get the ICMP carried data. | |
Ipv4Header | GetHeader () const |
Get the ICMP carried IPv4 header. | |
uint16_t | GetNextHopMtu () const |
Get the next hop MTU. | |
void | SetData (Ptr< const Packet > data) |
Set the ICMP carried data. | |
void | SetHeader (Ipv4Header header) |
Set the ICMP carried IPv4 header. | |
void | SetNextHopMtu (uint16_t mtu) |
Set the next hop MTU. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get ICMP type. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Member Functions | |
uint32_t | Deserialize (Buffer::Iterator start) override |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetSerializedSize () const override |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
Private Attributes | |
uint8_t | m_data [8] |
carried data | |
Ipv4Header | m_header |
carried IPv4 header | |
uint16_t | m_nextHopMtu |
next hop MTU | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
ICMP Destination Unreachable header.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet
Size of this type is 72 bytes (on a 64-bit architecture).
ns3::Icmpv4DestinationUnreachable::Icmpv4DestinationUnreachable | ( | ) |
Definition at line 301 of file icmpv4.cc.
References m_data, and NS_LOG_FUNCTION.
|
override |
|
overrideprivatevirtual |
start | an iterator which points to where the header should read from. |
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 385 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(), and ns3::Buffer::Iterator::ReadU8().
void ns3::Icmpv4DestinationUnreachable::GetData | ( | uint8_t | payload[8] | ) | const |
Get the ICMP carried data.
payload | the data (filled) |
Definition at line 341 of file icmpv4.cc.
References m_data, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::HandleDestUnreach().
Ipv4Header ns3::Icmpv4DestinationUnreachable::GetHeader | ( | ) | const |
Get the ICMP carried IPv4 header.
Definition at line 348 of file icmpv4.cc.
References m_header, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::HandleDestUnreach().
|
overrideprivatevirtual |
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.
Implements ns3::ObjectBase.
Definition at line 359 of file icmpv4.cc.
References GetTypeId(), and NS_LOG_FUNCTION.
uint16_t ns3::Icmpv4DestinationUnreachable::GetNextHopMtu | ( | ) | const |
Get the next hop MTU.
Definition at line 320 of file icmpv4.cc.
References m_nextHopMtu, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::HandleDestUnreach().
|
overrideprivatevirtual |
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 366 of file icmpv4.cc.
References ns3::Ipv4Header::GetSerializedSize(), m_header, and NS_LOG_FUNCTION.
|
static |
Get ICMP type.
Definition at line 292 of file icmpv4.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overrideprivatevirtual |
os | output 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 401 of file icmpv4.cc.
References m_data, m_header, NS_LOG_FUNCTION, and ns3::Ipv4Header::Print().
|
overrideprivatevirtual |
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 373 of file icmpv4.cc.
References ns3::Ipv4Header::GetSerializedSize(), m_data, m_header, m_nextHopMtu, NS_LOG_FUNCTION, and ns3::Ipv4Header::Serialize().
Set the ICMP carried data.
data | the data |
Definition at line 327 of file icmpv4.cc.
References data, m_data, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::SendDestUnreach().
void ns3::Icmpv4DestinationUnreachable::SetHeader | ( | Ipv4Header | header | ) |
Set the ICMP carried IPv4 header.
header | the header |
Definition at line 334 of file icmpv4.cc.
References m_header, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::SendDestUnreach().
void ns3::Icmpv4DestinationUnreachable::SetNextHopMtu | ( | uint16_t | mtu | ) |
Set the next hop MTU.
mtu | the MTU |
Definition at line 313 of file icmpv4.cc.
References m_nextHopMtu, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::SendDestUnreach().
|
private |
carried data
Definition at line 230 of file icmpv4.h.
Referenced by Icmpv4DestinationUnreachable(), Deserialize(), GetData(), Print(), Serialize(), and SetData().
|
private |
carried IPv4 header
Definition at line 229 of file icmpv4.h.
Referenced by Deserialize(), GetHeader(), GetSerializedSize(), Print(), Serialize(), and SetHeader().
|
private |
next hop MTU
Definition at line 228 of file icmpv4.h.
Referenced by Deserialize(), GetNextHopMtu(), Serialize(), and SetNextHopMtu().