ICMP Echo header. More...
#include "icmpv4.h"
Public Member Functions | |
Icmpv4Echo () | |
~Icmpv4Echo () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint32_t | GetData (uint8_t payload[]) const |
Get the Echo data. | |
uint32_t | GetDataSize () const |
Get the Echo data size. | |
uint16_t | GetIdentifier () const |
Get the Echo identifier. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint16_t | GetSequenceNumber () const |
Get the Echo sequence number. | |
uint32_t | GetSerializedSize () const override |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetData (Ptr< const Packet > data) |
Set the Echo data. | |
void | SetIdentifier (uint16_t id) |
Set the Echo identifier. | |
void | SetSequenceNumber (uint16_t seq) |
Set the Echo sequence number. | |
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 Attributes | |
uint8_t * | m_data |
data | |
uint32_t | m_dataSize |
data size | |
uint16_t | m_identifier |
identifier | |
uint16_t | m_sequence |
sequence number | |
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 Echo 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 32 bytes (on a 64-bit architecture).
ns3::Icmpv4Echo::Icmpv4Echo | ( | ) |
Definition at line 213 of file icmpv4.cc.
References m_data, m_dataSize, and NS_LOG_FUNCTION.
|
override |
Definition at line 226 of file icmpv4.cc.
References m_data, m_dataSize, and 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 258 of file icmpv4.cc.
References m_data, m_dataSize, m_identifier, m_sequence, NS_ASSERT, and NS_LOG_FUNCTION.
uint32_t ns3::Icmpv4Echo::GetData | ( | uint8_t | payload[] | ) | const |
Get the Echo data.
payload | the data (filled) |
Definition at line 196 of file icmpv4.cc.
References m_data, m_dataSize, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Receive().
uint32_t ns3::Icmpv4Echo::GetDataSize | ( | ) | const |
Get the Echo data size.
Definition at line 189 of file icmpv4.cc.
References m_dataSize, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().
uint16_t ns3::Icmpv4Echo::GetIdentifier | ( | ) | const |
Get the Echo identifier.
Definition at line 175 of file icmpv4.cc.
References m_identifier, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().
|
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 235 of file icmpv4.cc.
References GetTypeId(), and NS_LOG_FUNCTION.
uint16_t ns3::Icmpv4Echo::GetSequenceNumber | ( | ) | const |
Get the Echo sequence number.
Definition at line 182 of file icmpv4.cc.
References m_sequence, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().
|
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 242 of file icmpv4.cc.
References m_dataSize, and NS_LOG_FUNCTION.
|
static |
Get ICMP type.
Definition at line 204 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 278 of file icmpv4.cc.
References m_dataSize, m_identifier, m_sequence, 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 249 of file icmpv4.cc.
References m_data, m_dataSize, m_identifier, m_sequence, and NS_LOG_FUNCTION.
Set the Echo data.
data | the data |
Definition at line 153 of file icmpv4.cc.
References data, m_data, m_dataSize, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
void ns3::Icmpv4Echo::SetIdentifier | ( | uint16_t | id | ) |
Set the Echo identifier.
id | the identifier |
Definition at line 139 of file icmpv4.cc.
References m_identifier, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), IcmpEchoReplyTestCase::SendData(), IcmpTimeExceedTestCase::SendData(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
void ns3::Icmpv4Echo::SetSequenceNumber | ( | uint16_t | seq | ) |
Set the Echo sequence number.
seq | the sequence number |
Definition at line 146 of file icmpv4.cc.
References m_sequence, and NS_LOG_FUNCTION.
Referenced by ns3::Ping::Send(), ns3::V4TraceRoute::Send(), IcmpEchoReplyTestCase::SendData(), IcmpTimeExceedTestCase::SendData(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().
|
private |
data
Definition at line 154 of file icmpv4.h.
Referenced by Icmpv4Echo(), ~Icmpv4Echo(), Deserialize(), GetData(), Serialize(), and SetData().
|
private |
data size
Definition at line 155 of file icmpv4.h.
Referenced by Icmpv4Echo(), ~Icmpv4Echo(), Deserialize(), GetData(), GetDataSize(), GetSerializedSize(), Print(), Serialize(), and SetData().
|
private |
identifier
Definition at line 152 of file icmpv4.h.
Referenced by Deserialize(), GetIdentifier(), Print(), Serialize(), and SetIdentifier().
|
private |
sequence number
Definition at line 153 of file icmpv4.h.
Referenced by Deserialize(), GetSequenceNumber(), Print(), Serialize(), and SetSequenceNumber().