ns3::Icmpv6Echo Class Reference

ICMPv6 Echo message. More...

#include <icmpv6-header.h>

Inheritance diagram for ns3::Icmpv6Echo:

Collaboration diagram for ns3::Icmpv6Echo:

List of all members.

Public Member Functions
virtual TypeId	GetInstanceTypeId () const
	Get the instance type ID.
	Icmpv6Echo ()
	Default constructor.
	Icmpv6Echo (bool request)
	Constructor.
virtual	~Icmpv6Echo ()
	Destructor.
uint16_t	GetId () const
	Get the ID of the packet.
void	SetId (uint16_t id)
	Set the ID of the packet.
uint16_t	GetSeq () const
	Get the sequence number.
void	SetSeq (uint16_t seq)
	Set the sequence number.
virtual void	Print (std::ostream &os) const
	Print informations.
virtual uint32_t	GetSerializedSize () const
	Get the serialized size.
virtual void	Serialize (Buffer::Iterator start) const
	Serialize the packet.
virtual uint32_t	Deserialize (Buffer::Iterator start)
	Deserialize the packet.
Static Public Member Functions
static TypeId	GetTypeId ()
	Get the UID of this class.

---

Detailed Description

ICMPv6 Echo message.

---

Constructor & Destructor Documentation

ns3::Icmpv6Echo::Icmpv6Echo

(

bool

request

)

Constructor.

Parameters:

request

request or reply message

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

---

Member Function Documentation

uint32_t ns3::Icmpv6Echo::Deserialize

(

Buffer::Iterator

start

)

[virtual]

Deserialize the packet.

Parameters:

start

start offset

Returns:

length of packet

Reimplemented from ns3::Icmpv6Header.

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

uint16_t ns3::Icmpv6Echo::GetId

(

)

const

Get the ID of the packet.

Returns:

id

TypeId ns3::Icmpv6Echo::GetInstanceTypeId

(

void

)

const [virtual]

Get the instance type ID.

Returns:

instance type ID

Reimplemented from ns3::Icmpv6Header.

References GetTypeId().

uint16_t ns3::Icmpv6Echo::GetSeq

(

void

)

const

Get the sequence number.

Returns:

sequence number

uint32_t ns3::Icmpv6Echo::GetSerializedSize

(

void

)

const [virtual]

Get the serialized size.

Returns:

serialized size

Reimplemented from ns3::Icmpv6Header.

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

TypeId ns3::Icmpv6Echo::GetTypeId

(

void

)

[static]

Get the UID of this class.

This method returns the TypeId associated to ns3::Icmpv6Echo.

Returns:

UID

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

Reimplemented from ns3::Icmpv6Header.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::Icmpv6Echo::Print

(

std::ostream &

os

)

const [virtual]

Print informations.

Parameters:

os	output stream

Reimplemented from ns3::Icmpv6Header.

References ns3::Icmpv6Header::GetChecksum(), ns3::Icmpv6Header::GetCode(), and ns3::Icmpv6Header::GetType().

void ns3::Icmpv6Echo::Serialize

(

Buffer::Iterator

start

)

const [virtual]

Serialize the packet.

Parameters:

start

start offset

Reimplemented from ns3::Icmpv6Header.

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

void ns3::Icmpv6Echo::SetId

(

uint16_t

id

)

Set the ID of the packet.

Parameters:

id

id to set

Referenced by ns3::Icmpv6L4Protocol::ForgeEchoRequest(), Icmpv6Echo(), and ns3::Icmpv6L4Protocol::SendEchoReply().

void ns3::Icmpv6Echo::SetSeq

(

uint16_t

seq

)

Set the sequence number.

Parameters:

seq	sequence to set

Referenced by ns3::Icmpv6L4Protocol::ForgeEchoRequest(), Icmpv6Echo(), and ns3::Icmpv6L4Protocol::SendEchoReply().

---

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

• src/internet/model/icmpv6-header.h
• doc/introspected-doxygen.h
• src/internet/model/icmpv6-header.cc