Base class for all the ICMP packet headers. More...
#include "icmpv4.h"
Public Types | |
enum | Type_e { ICMPV4_ECHO_REPLY = 0 , ICMPV4_DEST_UNREACH = 3 , ICMPV4_ECHO = 8 , ICMPV4_TIME_EXCEEDED = 11 } |
ICMP type code. More... | |
Public Member Functions | |
Icmpv4Header () | |
~Icmpv4Header () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
void | EnableChecksum () |
Enables ICMP Checksum calculation. | |
uint8_t | GetCode () const |
Get ICMP code. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetSerializedSize () const override |
uint8_t | GetType () const |
Get ICMP type. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetCode (uint8_t code) |
Set ICMP code. | |
void | SetType (uint8_t type) |
Set ICMP type. | |
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 the type ID. | |
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 Attributes | |
bool | m_calcChecksum |
true if checksum is calculated | |
uint8_t | m_code |
ICMP code. | |
uint8_t | m_type |
ICMP type. | |
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. | |
Base class for all the ICMP packet headers.
Introspection did not find any typical Config paths.
This header is the common part in all the ICMP packets.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet
Size of this type is 16 bytes (on a 64-bit architecture).
ns3::Icmpv4Header::Icmpv4Header | ( | ) |
Definition at line 35 of file icmpv4.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 43 of file icmpv4.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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 88 of file icmpv4.cc.
References m_code, m_type, and NS_LOG_FUNCTION.
void ns3::Icmpv4Header::EnableChecksum | ( | ) |
Enables ICMP Checksum calculation.
Definition at line 49 of file icmpv4.cc.
References m_calcChecksum, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), ns3::Icmpv4L4Protocol::SendMessage(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
uint8_t ns3::Icmpv4Header::GetCode | ( | ) | const |
Get ICMP code.
Definition at line 126 of file icmpv4.cc.
References m_code, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::Forward().
|
overridevirtual |
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 56 of file icmpv4.cc.
References GetTypeId(), and NS_LOG_FUNCTION.
|
overridevirtual |
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 63 of file icmpv4.cc.
References NS_LOG_FUNCTION.
uint8_t ns3::Icmpv4Header::GetType | ( | ) | const |
Get ICMP type.
Definition at line 119 of file icmpv4.cc.
References m_type, and NS_LOG_FUNCTION.
Referenced by ns3::Icmpv4L4Protocol::Forward(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::Icmpv4L4Protocol::Receive(), ns3::olsr::Bug780Test::Receive(), ns3::Ping::Receive(), ns3::V4TraceRoute::Receive(), IcmpEchoReplyTestCase::ReceivePkt(), and IcmpTimeExceedTestCase::ReceivePkt().
|
static |
Get the type ID.
Definition at line 26 of file icmpv4.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
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 98 of file icmpv4.cc.
References m_code, m_type, and NS_LOG_FUNCTION.
|
overridevirtual |
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 70 of file icmpv4.cc.
References ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Buffer::Iterator::GetSize(), m_calcChecksum, m_code, m_type, ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().
void ns3::Icmpv4Header::SetCode | ( | uint8_t | code | ) |
Set ICMP code.
code | the ICMP code |
Definition at line 112 of file icmpv4.cc.
References m_code, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), IcmpEchoReplyTestCase::SendData(), IcmpTimeExceedTestCase::SendData(), ns3::Icmpv4L4Protocol::SendMessage(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
void ns3::Icmpv4Header::SetType | ( | uint8_t | type | ) |
Set ICMP type.
type | the ICMP type |
Definition at line 105 of file icmpv4.cc.
References m_type, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), IcmpEchoReplyTestCase::SendData(), IcmpTimeExceedTestCase::SendData(), ns3::Icmpv4L4Protocol::SendMessage(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
|
private |
true if checksum is calculated
Definition at line 90 of file icmpv4.h.
Referenced by EnableChecksum(), and Serialize().
|
private |
ICMP code.
Definition at line 89 of file icmpv4.h.
Referenced by Deserialize(), GetCode(), Print(), Serialize(), and SetCode().
|
private |
ICMP type.
Definition at line 88 of file icmpv4.h.
Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().