A Discrete-Event Network Simulator
API

ICMP Echo header. More...

#include "icmpv4.h"

+ Inheritance diagram for ns3::Icmpv4Echo:
+ Collaboration diagram for ns3::Icmpv4Echo:

Public Member Functions

 Icmpv4Echo ()
 
 ~Icmpv4Echo () override
 
uint32_t Deserialize (Buffer::Iterator start) override
 
uint32_t GetData (uint8_t payload[]) const
 Get the Echo data. More...
 
uint32_t GetDataSize () const
 Get the Echo data size. More...
 
uint16_t GetIdentifier () const
 Get the Echo identifier. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
uint16_t GetSequenceNumber () const
 Get the Echo sequence number. More...
 
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. More...
 
void SetIdentifier (uint16_t id)
 Set the Echo identifier. More...
 
void SetSequenceNumber (uint16_t seq)
 Set the Echo sequence number. More...
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
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 errors. 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 ()
 Get ICMP type. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

uint8_t * m_data
 data More...
 
uint32_t m_dataSize
 data size More...
 
uint16_t m_identifier
 identifier More...
 
uint16_t m_sequence
 sequence number 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

ICMP Echo header.

Definition at line 109 of file icmpv4.h.

Constructor & Destructor Documentation

◆ Icmpv4Echo()

ns3::Icmpv4Echo::Icmpv4Echo ( )

Definition at line 224 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

◆ ~Icmpv4Echo()

ns3::Icmpv4Echo::~Icmpv4Echo ( )
override

Definition at line 237 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::Icmpv4Echo::Deserialize ( Buffer::Iterator  start)
overridevirtual
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 269 of file icmpv4.cc.

References m_data, m_dataSize, m_identifier, m_sequence, NS_ASSERT, NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::start.

◆ GetData()

uint32_t ns3::Icmpv4Echo::GetData ( uint8_t  payload[]) const

Get the Echo data.

Parameters
payloadthe data (filled)
Returns
the data length

Definition at line 207 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

Referenced by ns3::Ping::Receive().

+ Here is the caller graph for this function:

◆ GetDataSize()

uint32_t ns3::Icmpv4Echo::GetDataSize ( ) const

Get the Echo data size.

Returns
the data size

Definition at line 200 of file icmpv4.cc.

References m_dataSize, and NS_LOG_FUNCTION.

Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().

+ Here is the caller graph for this function:

◆ GetIdentifier()

uint16_t ns3::Icmpv4Echo::GetIdentifier ( ) const

Get the Echo identifier.

Returns
the identifier

Definition at line 186 of file icmpv4.cc.

References m_identifier, and NS_LOG_FUNCTION.

Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Icmpv4Echo::GetInstanceTypeId ( ) const
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.

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 246 of file icmpv4.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetSequenceNumber()

uint16_t ns3::Icmpv4Echo::GetSequenceNumber ( ) const

Get the Echo sequence number.

Returns
the sequence number

Definition at line 193 of file icmpv4.cc.

References m_sequence, and NS_LOG_FUNCTION.

Referenced by ns3::Ping::Receive(), and ns3::V4TraceRoute::Receive().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Icmpv4Echo::GetSerializedSize ( ) const
overridevirtual
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 253 of file icmpv4.cc.

References m_dataSize, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get ICMP type.

Returns
the ICMP type

Definition at line 215 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::Icmpv4Echo::Print ( std::ostream &  os) const
overridevirtual
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 289 of file icmpv4.cc.

References m_dataSize, m_identifier, m_sequence, and NS_LOG_FUNCTION.

◆ Serialize()

void ns3::Icmpv4Echo::Serialize ( Buffer::Iterator  start) const
overridevirtual
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 260 of file icmpv4.cc.

References m_data, m_dataSize, m_identifier, m_sequence, NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::start.

◆ SetData()

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

Set the Echo data.

Parameters
datathe data

Definition at line 164 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().

+ Here is the caller graph for this function:

◆ SetIdentifier()

void ns3::Icmpv4Echo::SetIdentifier ( uint16_t  id)

Set the Echo identifier.

Parameters
idthe identifier

Definition at line 150 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().

+ Here is the caller graph for this function:

◆ SetSequenceNumber()

void ns3::Icmpv4Echo::SetSequenceNumber ( uint16_t  seq)

Set the Echo sequence number.

Parameters
seqthe sequence number

Definition at line 157 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().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_data

uint8_t* ns3::Icmpv4Echo::m_data
private

data

Definition at line 165 of file icmpv4.h.

Referenced by Icmpv4Echo(), ~Icmpv4Echo(), Deserialize(), GetData(), Serialize(), and SetData().

◆ m_dataSize

uint32_t ns3::Icmpv4Echo::m_dataSize
private

◆ m_identifier

uint16_t ns3::Icmpv4Echo::m_identifier
private

identifier

Definition at line 163 of file icmpv4.h.

Referenced by Deserialize(), GetIdentifier(), Print(), Serialize(), and SetIdentifier().

◆ m_sequence

uint16_t ns3::Icmpv4Echo::m_sequence
private

sequence number

Definition at line 164 of file icmpv4.h.

Referenced by Deserialize(), GetSequenceNumber(), Print(), Serialize(), and SetSequenceNumber().


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