A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Icmpv4Echo Class Reference

#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
 
uint32_t GetDataSize (void) const
 
uint16_t GetIdentifier (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
uint16_t GetSequenceNumber (void) const
 
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)
 
void SetIdentifier (uint16_t id)
 
void SetSequenceNumber (uint16_t seq)
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
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)
 
- 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)
 

Private Attributes

uint8_t * m_data
 
uint32_t m_dataSize
 
uint16_t m_identifier
 
uint16_t m_sequence
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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 65 of file icmpv4.h.

Constructor & Destructor Documentation

ns3::Icmpv4Echo::Icmpv4Echo ( )

Definition at line 205 of file icmpv4.cc.

References m_data, m_dataSize, and NS_LOG_FUNCTION.

ns3::Icmpv4Echo::~Icmpv4Echo ( )
virtual

Definition at line 217 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
startan 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 245 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

Definition at line 190 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

Definition at line 184 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

Definition at line 172 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 225 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

Definition at line 178 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 231 of file icmpv4.cc.

References m_dataSize, and NS_LOG_FUNCTION.

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

Definition at line 197 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
osoutput 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 262 of file icmpv4.cc.

References m_identifier, m_sequence, and NS_LOG_FUNCTION.

void ns3::Icmpv4Echo::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 237 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:

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

Definition at line 151 of file icmpv4.cc.

References ns3::Packet::CopyData(), ns3::Packet::GetSize(), m_data, m_dataSize, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

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

Definition at line 139 of file icmpv4.cc.

References m_identifier, and NS_LOG_FUNCTION.

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

Definition at line 145 of file icmpv4.cc.

References m_sequence, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t* ns3::Icmpv4Echo::m_data
private

Definition at line 88 of file icmpv4.h.

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

uint32_t ns3::Icmpv4Echo::m_dataSize
private
uint16_t ns3::Icmpv4Echo::m_identifier
private

Definition at line 86 of file icmpv4.h.

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

uint16_t ns3::Icmpv4Echo::m_sequence
private

Definition at line 87 of file icmpv4.h.

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


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