A Discrete-Event Network Simulator
API

Base class for all the ICMP packet headers. More...

#include "icmpv4.h"

+ Inheritance diagram for ns3::Icmpv4Header:
+ Collaboration diagram for ns3::Icmpv4Header:

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 ()
 
virtual ~Icmpv4Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
void EnableChecksum (void)
 Enables ICMP Checksum calculation. More...
 
uint8_t GetCode (void) const
 Get ICMP code. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
virtual uint32_t GetSerializedSize (void) const
 
uint8_t GetType (void) const
 Get ICMP type. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetCode (uint8_t code)
 Set ICMP code. More...
 
void SetType (uint8_t type)
 Set ICMP type. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t GetSerializedSize (void) const =0
 
virtual void Print (std::ostream &os) const =0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
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...
 
virtual void Print (std::ostream &os) const =0
 Print the object contents. 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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

bool m_calcChecksum
 true if checksum is calculated More...
 
uint8_t m_code
 ICMP code. More...
 
uint8_t m_type
 ICMP type. 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

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.
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 40 of file icmpv4.h.

Member Enumeration Documentation

◆ Type_e

ICMP type code.

Enumerator
ICMPV4_ECHO_REPLY 
ICMPV4_DEST_UNREACH 
ICMPV4_ECHO 
ICMPV4_TIME_EXCEEDED 

Definition at line 47 of file icmpv4.h.

Constructor & Destructor Documentation

◆ Icmpv4Header()

ns3::Icmpv4Header::Icmpv4Header ( )

Definition at line 45 of file icmpv4.cc.

References NS_LOG_FUNCTION.

◆ ~Icmpv4Header()

ns3::Icmpv4Header::~Icmpv4Header ( )
virtual

Definition at line 52 of file icmpv4.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::Icmpv4Header::Deserialize ( Buffer::Iterator  start)
virtual
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 93 of file icmpv4.cc.

References m_code, m_type, NS_LOG_FUNCTION, and visualizer.core::start().

+ Here is the call graph for this function:

◆ EnableChecksum()

void ns3::Icmpv4Header::EnableChecksum ( void  )

Enables ICMP Checksum calculation.

Definition at line 57 of file icmpv4.cc.

References m_calcChecksum, and NS_LOG_FUNCTION.

Referenced by ns3::V4Ping::Send(), ns3::V4TraceRoute::Send(), ns3::Icmpv4L4Protocol::SendMessage(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().

+ Here is the caller graph for this function:

◆ GetCode()

uint8_t ns3::Icmpv4Header::GetCode ( void  ) const

Get ICMP code.

Returns
the ICMP code

Definition at line 127 of file icmpv4.cc.

References m_code, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Icmpv4Header::GetInstanceTypeId ( void  ) const
virtual

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 63 of file icmpv4.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Icmpv4Header::GetSerializedSize ( void  ) const
virtual
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 69 of file icmpv4.cc.

References NS_LOG_FUNCTION.

◆ GetType()

uint8_t ns3::Icmpv4Header::GetType ( void  ) const

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 36 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::Icmpv4Header::Print ( std::ostream &  os) const
virtual
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 102 of file icmpv4.cc.

References m_code, m_type, and NS_LOG_FUNCTION.

◆ Serialize()

void ns3::Icmpv4Header::Serialize ( Buffer::Iterator  start) const
virtual
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 75 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, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetCode()

void ns3::Icmpv4Header::SetCode ( uint8_t  code)

Set ICMP code.

Parameters
codethe ICMP code

Definition at line 115 of file icmpv4.cc.

References m_code, and NS_LOG_FUNCTION.

Referenced by ns3::V4Ping::Send(), ns3::V4TraceRoute::Send(), IcmpEchoReplyTestCase::SendData(), IcmpTimeExceedTestCase::SendData(), ns3::Icmpv4L4Protocol::SendMessage(), ChainRegressionTest::SendPing(), and ns3::olsr::Bug780Test::SendPing().

+ Here is the caller graph for this function:

◆ SetType()

void ns3::Icmpv4Header::SetType ( uint8_t  type)

Member Data Documentation

◆ m_calcChecksum

bool ns3::Icmpv4Header::m_calcChecksum
private

true if checksum is calculated

Definition at line 99 of file icmpv4.h.

Referenced by EnableChecksum(), and Serialize().

◆ m_code

uint8_t ns3::Icmpv4Header::m_code
private

ICMP code.

Definition at line 98 of file icmpv4.h.

Referenced by Deserialize(), GetCode(), Print(), Serialize(), and SetCode().

◆ m_type

uint8_t ns3::Icmpv4Header::m_type
private

ICMP type.

Definition at line 97 of file icmpv4.h.

Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().


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