A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches

ICMPv6 Echo message. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6Echo:
+ Collaboration diagram for ns3::Icmpv6Echo:

Public Member Functions

 Icmpv6Echo ()
 Default constructor.
 
 Icmpv6Echo (bool request)
 Constructor.
 
 ~Icmpv6Echo () override
 Destructor.
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet.
 
uint16_t GetId () const
 Get the ID of the packet.
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID.
 
uint16_t GetSeq () const
 Get the sequence number.
 
uint32_t GetSerializedSize () const override
 Get the serialized size.
 
void Print (std::ostream &os) const override
 Print information.
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet.
 
void SetId (uint16_t id)
 Set the ID of the packet.
 
void SetSeq (uint16_t seq)
 Set the sequence number.
 
- Public Member Functions inherited from ns3::Icmpv6Header
 Icmpv6Header ()
 Constructor.
 
 ~Icmpv6Header () override
 Destructor.
 
void CalculatePseudoHeaderChecksum (Ipv6Address src, Ipv6Address dst, uint16_t length, uint8_t protocol)
 Calculate pseudo header checksum for IPv6.
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet.
 
uint16_t GetChecksum () const
 Get the checksum.
 
uint8_t GetCode () const
 Get the code field.
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID.
 
uint32_t GetSerializedSize () const override
 Get the serialized size.
 
uint8_t GetType () const
 Get the type field.
 
void Print (std::ostream &os) const override
 Print information.
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet.
 
void SetChecksum (uint16_t checksum)
 Set the checksum.
 
void SetCode (uint8_t code)
 Set the code field.
 
void SetType (uint8_t type)
 Set the type.
 
- 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 the UID of this class.
 
- Static Public Member Functions inherited from ns3::Icmpv6Header
static TypeId GetTypeId ()
 Get the UID of this class.
 
- 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

uint16_t m_id
 ID of the packet (to distinguish response between many ping program).
 
uint16_t m_seq
 Sequence number (to distinguish response).
 

Additional Inherited Members

- Public Types inherited from ns3::Icmpv6Header
enum  ErrorDestinationUnreachable_e {
  ICMPV6_NO_ROUTE = 0 , ICMPV6_ADM_PROHIBITED , ICMPV6_NOT_NEIGHBOUR , ICMPV6_ADDR_UNREACHABLE ,
  ICMPV6_PORT_UNREACHABLE
}
 ICMPv6 error code : Destination Unreachable. More...
 
enum  ErrorParameterError_e { ICMPV6_MALFORMED_HEADER = 0 , ICMPV6_UNKNOWN_NEXT_HEADER , ICMPV6_UNKNOWN_OPTION }
 ICMPv6 error code : Parameter Error. More...
 
enum  ErrorTimeExceeded_e { ICMPV6_HOPLIMIT = 0 , ICMPV6_FRAGTIME }
 ICMPv6 error code : Time Exceeded. More...
 
enum  OptionType_e {
  ICMPV6_OPT_LINK_LAYER_SOURCE = 1 , ICMPV6_OPT_LINK_LAYER_TARGET , ICMPV6_OPT_PREFIX , ICMPV6_OPT_REDIRECTED ,
  ICMPV6_OPT_MTU
}
 ICMPv6 Option type code. More...
 
enum  Type_e {
  ICMPV6_ERROR_DESTINATION_UNREACHABLE = 1 , ICMPV6_ERROR_PACKET_TOO_BIG , ICMPV6_ERROR_TIME_EXCEEDED , ICMPV6_ERROR_PARAMETER_ERROR ,
  ICMPV6_ECHO_REQUEST = 128 , ICMPV6_ECHO_REPLY , ICMPV6_SUBSCRIBE_REQUEST , ICMPV6_SUBSCRIBE_REPORT ,
  ICMPV6_SUBSCRIVE_END , ICMPV6_ND_ROUTER_SOLICITATION , ICMPV6_ND_ROUTER_ADVERTISEMENT , ICMPV6_ND_NEIGHBOR_SOLICITATION ,
  ICMPV6_ND_NEIGHBOR_ADVERTISEMENT , ICMPV6_ND_REDIRECTION , ICMPV6_ROUTER_RENUMBER , ICMPV6_INFORMATION_REQUEST ,
  ICMPV6_INFORMATION_RESPONSE , ICMPV6_INVERSE_ND_SOLICITATION , ICMPV6_INVERSE_ND_ADVERSTISEMENT , ICMPV6_MLDV2_SUBSCRIBE_REPORT ,
  ICMPV6_MOBILITY_HA_DISCOVER_REQUEST , ICMPV6_MOBILITY_HA_DISCOVER_RESPONSE , ICMPV6_MOBILITY_MOBILE_PREFIX_SOLICITATION , ICMPV6_SECURE_ND_CERTIFICATE_PATH_SOLICITATION ,
  ICMPV6_SECURE_ND_CERTIFICATE_PATH_ADVERTISEMENT , ICMPV6_EXPERIMENTAL_MOBILITY
}
 ICMPv6 type code. More...
 
- 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.
 
- Protected Attributes inherited from ns3::Icmpv6Header
bool m_calcChecksum
 Checksum enable or not.
 
uint16_t m_checksum
 The checksum.
 

Detailed Description

ICMPv6 Echo message.

Definition at line 917 of file icmpv6-header.h.

Constructor & Destructor Documentation

◆ Icmpv6Echo() [1/2]

ns3::Icmpv6Echo::Icmpv6Echo ( )

Default constructor.

Definition at line 1002 of file icmpv6-header.cc.

References ns3::Icmpv6Header::ICMPV6_ECHO_REQUEST, ns3::Icmpv6Header::m_checksum, NS_LOG_FUNCTION, ns3::Icmpv6Header::SetCode(), SetId(), SetSeq(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

◆ Icmpv6Echo() [2/2]

ns3::Icmpv6Echo::Icmpv6Echo ( bool request)

Constructor.

Parameters
requestrequest or reply message

Definition at line 1012 of file icmpv6-header.cc.

References ns3::Icmpv6Header::ICMPV6_ECHO_REPLY, ns3::Icmpv6Header::ICMPV6_ECHO_REQUEST, ns3::Icmpv6Header::m_checksum, NS_LOG_FUNCTION, ns3::Icmpv6Header::SetCode(), SetId(), SetSeq(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

◆ ~Icmpv6Echo()

ns3::Icmpv6Echo::~Icmpv6Echo ( )
override

Destructor.

Definition at line 1022 of file icmpv6-header.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::Icmpv6Echo::Deserialize ( Buffer::Iterator start)
overridevirtual

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Implements ns3::Header.

Definition at line 1096 of file icmpv6-header.cc.

References GetSerializedSize(), ns3::Icmpv6Header::m_checksum, m_id, m_seq, NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Icmpv6Header::SetCode(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

◆ GetId()

uint16_t ns3::Icmpv6Echo::GetId ( ) const

Get the ID of the packet.

Returns
id

Definition at line 1028 of file icmpv6-header.cc.

References m_id, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleEchoRequest(), Print(), and ns3::Ping::Receive().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Icmpv6Echo::GetInstanceTypeId ( ) const
overridevirtual

Get the instance type ID.

Returns
instance type ID

Implements ns3::ObjectBase.

Definition at line 996 of file icmpv6-header.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetSeq()

uint16_t ns3::Icmpv6Echo::GetSeq ( ) const

Get the sequence number.

Returns
sequence number

Definition at line 1042 of file icmpv6-header.cc.

References m_seq, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleEchoRequest(), Print(), and ns3::Ping::Receive().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Icmpv6Echo::GetSerializedSize ( ) const
overridevirtual

Get the serialized size.

Returns
serialized size

Implements ns3::Header.

Definition at line 1065 of file icmpv6-header.cc.

References NS_LOG_FUNCTION.

Referenced by Deserialize(), ns3::Icmpv6L4Protocol::ForgeEchoRequest(), ns3::Icmpv6L4Protocol::SendEchoReply(), and ns3::Ipv6RawSocketImpl::SendTo().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Icmpv6Echo::GetTypeId ( )
static

Get the UID of this class.

Returns
UID

Definition at line 986 of file icmpv6-header.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::Icmpv6Echo::Print ( std::ostream & os) const
overridevirtual

Print information.

Parameters
osoutput stream

Implements ns3::Header.

Definition at line 1056 of file icmpv6-header.cc.

References ns3::Icmpv6Header::GetChecksum(), GetId(), GetSeq(), ns3::Icmpv6Header::GetType(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::Icmpv6Echo::Serialize ( Buffer::Iterator start) const
overridevirtual

Serialize the packet.

Parameters
startstart offset

Implements ns3::Header.

Definition at line 1072 of file icmpv6-header.cc.

References ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Icmpv6Header::GetChecksum(), ns3::Icmpv6Header::GetCode(), ns3::Buffer::Iterator::GetSize(), ns3::Icmpv6Header::GetType(), ns3::Icmpv6Header::m_calcChecksum, m_id, m_seq, ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetId()

void ns3::Icmpv6Echo::SetId ( uint16_t id)

Set the ID of the packet.

Parameters
idid to set

Definition at line 1035 of file icmpv6-header.cc.

References m_id, and NS_LOG_FUNCTION.

Referenced by Icmpv6Echo(), Icmpv6Echo(), ns3::Icmpv6L4Protocol::ForgeEchoRequest(), ns3::Ping::Send(), IcmpV6EchoReplyTestCase::SendData(), IcmpV6TimeExceedTestCase::SendData(), and ns3::Icmpv6L4Protocol::SendEchoReply().

+ Here is the caller graph for this function:

◆ SetSeq()

void ns3::Icmpv6Echo::SetSeq ( uint16_t seq)

Set the sequence number.

Parameters
seqsequence to set

Definition at line 1049 of file icmpv6-header.cc.

References m_seq, and NS_LOG_FUNCTION.

Referenced by Icmpv6Echo(), Icmpv6Echo(), ns3::Icmpv6L4Protocol::ForgeEchoRequest(), ns3::Ping::Send(), IcmpV6EchoReplyTestCase::SendData(), IcmpV6TimeExceedTestCase::SendData(), and ns3::Icmpv6L4Protocol::SendEchoReply().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_id

uint16_t ns3::Icmpv6Echo::m_id
private

ID of the packet (to distinguish response between many ping program).

Definition at line 1001 of file icmpv6-header.h.

Referenced by Deserialize(), GetId(), Serialize(), and SetId().

◆ m_seq

uint16_t ns3::Icmpv6Echo::m_seq
private

Sequence number (to distinguish response).

Definition at line 1006 of file icmpv6-header.h.

Referenced by Deserialize(), GetSeq(), Serialize(), and SetSeq().


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