Doxygen introspection did not find any typical Config paths. More...

#include <icmpv4.h>

Inheritance diagram for ns3::Icmpv4Echo:

Collaboration diagram for ns3::Icmpv4Echo:

Public Member Functions
	Icmpv4Echo ()

virtual	~Icmpv4Echo ()

virtual uint32_t	Deserialize (Buffer::Iterator start)

uint32_t	GetData (uint8_t payload[]) const
	Get the Echo data. More...

uint32_t	GetDataSize (void) const
	Get the Echo data size. More...

uint16_t	GetIdentifier (void) const
	Get the Echo identifier. More...

virtual TypeId	GetInstanceTypeId (void) const

uint16_t	GetSequenceNumber (void) const
	Get the Echo sequence number. More...

virtual uint32_t	GetSerializedSize (void) const

virtual void	Print (std::ostream &os) const

virtual void	Serialize (Buffer::Iterator start) const

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
virtual	~Header ()

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get ICMP type. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	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)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Doxygen introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 91 of file icmpv4.h.

Constructor & Destructor Documentation

ns3::Icmpv4Echo::Icmpv4Echo ( )

Definition at line 207 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

ns3::Icmpv4Echo::~Icmpv4Echo ( )

virtual

Definition at line 219 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::Icmpv4Echo::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should written.

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.

Implements ns3::Header.

Definition at line 247 of file icmpv4.cc.

References ns3::Buffer::Iterator::GetSize(), m_data, m_dataSize, m_identifier, m_sequence, NS_ASSERT, NS_LOG_FUNCTION, ns3::Buffer::Iterator::Read(), and ns3::Buffer::Iterator::ReadNtohU16().

Here is the call graph for this function:

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

Get the Echo data.

Parameters

payload the data (filled)

Returns: the data length

Definition at line 192 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

uint32_t ns3::Icmpv4Echo::GetDataSize ( void ) const

Get the Echo data size.

Returns: the data size

Definition at line 186 of file icmpv4.cc.

References m_dataSize, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

uint16_t ns3::Icmpv4Echo::GetIdentifier ( void ) const

Get the Echo identifier.

Returns: the identifier

Definition at line 174 of file icmpv4.cc.

References m_identifier, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

TypeId ns3::Icmpv4Echo::GetInstanceTypeId ( void ) const

virtual

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

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

References GetTypeId(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

uint16_t ns3::Icmpv4Echo::GetSequenceNumber ( void ) const

Get the Echo sequence number.

Returns: the sequence number

Definition at line 180 of file icmpv4.cc.

References m_sequence, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

uint32_t ns3::Icmpv4Echo::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 233 of file icmpv4.cc.

References m_dataSize, and NS_LOG_FUNCTION.

TypeId ns3::Icmpv4Echo::GetTypeId ( void )

static

Get ICMP type.

Returns: the ICMP type

Definition at line 199 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:

void ns3::Icmpv4Echo::Print ( std::ostream & os ) const

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 264 of file icmpv4.cc.

References m_identifier, m_sequence, and NS_LOG_FUNCTION.

void ns3::Icmpv4Echo::Serialize ( Buffer::Iterator start ) const

virtual

Parameters

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

References m_data, m_dataSize, m_identifier, m_sequence, NS_LOG_FUNCTION, ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteHtonU16().

Here is the call graph for this function: