ns3::Ipv4PacketInfoTag Class Reference

This class implements Linux struct pktinfo in order to deliver ancillary information to the socket interface. This is used with socket option such as IP_PKTINFO, IP_RECVTTL, IP_RECVTOS. See linux manpage ip(7). More...

#include <ipv4-packet-info-tag.h>

Inheritance diagram for ns3::Ipv4PacketInfoTag:

Collaboration diagram for ns3::Ipv4PacketInfoTag:

Public Member Functions
	Ipv4PacketInfoTag ()
virtual void	Deserialize (TagBuffer i)
Ipv4Address	GetAddress (void) const
virtual TypeId	GetInstanceTypeId (void) const
Ipv4Address	GetLocalAddress (void) const
uint32_t	GetRecvIf (void) const
virtual uint32_t	GetSerializedSize (void) const
uint8_t	GetTtl (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetAddress (Ipv4Address addr)
void	SetLocalAddress (Ipv4Address addr)
void	SetRecvIf (uint32_t ifindex)
void	SetTtl (uint8_t ttl)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Tag.

Private Attributes
Ipv4Address	m_addr
uint32_t	m_ifindex
Ipv4Address	m_spec_dst
uint8_t	m_ttl

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

Detailed Description

This class implements Linux struct pktinfo in order to deliver ancillary information to the socket interface. This is used with socket option such as IP_PKTINFO, IP_RECVTTL, IP_RECVTOS. See linux manpage ip(7).

This tag in the send direction is presently not enabled but we would accept a patch along those lines in the future.

Definition at line 42 of file ipv4-packet-info-tag.h.

Constructor & Destructor Documentation

ns3::Ipv4PacketInfoTag::Ipv4PacketInfoTag

(

)

Definition at line 28 of file ipv4-packet-info-tag.cc.

Member Function Documentation

void ns3::Ipv4PacketInfoTag::Deserialize ( TagBuffer  i )

virtual

Parameters

i	the buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

Definition at line 120 of file ipv4-packet-info-tag.cc.

References m_addr, m_ifindex, m_spec_dst, m_ttl, ns3::TagBuffer::Read(), ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

Ipv4Address ns3::Ipv4PacketInfoTag::GetAddress

(

void

)

const

Definition at line 43 of file ipv4-packet-info-tag.cc.

References m_addr.

TypeId ns3::Ipv4PacketInfoTag::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 96 of file ipv4-packet-info-tag.cc.

References GetTypeId().

Here is the call graph for this function:

Ipv4Address ns3::Ipv4PacketInfoTag::GetLocalAddress

(

void

)

const

Definition at line 55 of file ipv4-packet-info-tag.cc.

References m_spec_dst.

uint32_t ns3::Ipv4PacketInfoTag::GetRecvIf

(

void

)

const

Definition at line 67 of file ipv4-packet-info-tag.cc.

References m_ifindex.

Referenced by DynamicGlobalRoutingTestCase::HandleRead().

Here is the caller graph for this function:

uint32_t ns3::Ipv4PacketInfoTag::GetSerializedSize ( void  ) const

virtual

Returns

the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 102 of file ipv4-packet-info-tag.cc.

uint8_t ns3::Ipv4PacketInfoTag::GetTtl

(

void

)

const

Definition at line 79 of file ipv4-packet-info-tag.cc.

References m_ttl.

TypeId ns3::Ipv4PacketInfoTag::GetTypeId ( void  )

static

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

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

Reimplemented from ns3::Tag.

Definition at line 87 of file ipv4-packet-info-tag.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::Ipv4PacketInfoTag::Print ( std::ostream &  os ) const

virtual

Parameters

os	the stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 131 of file ipv4-packet-info-tag.cc.

References m_addr, m_ifindex, m_spec_dst, and m_ttl.

void ns3::Ipv4PacketInfoTag::Serialize ( TagBuffer  i ) const

virtual

Parameters

i	the buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

Definition at line 109 of file ipv4-packet-info-tag.cc.

References m_addr, m_ifindex, m_spec_dst, m_ttl, ns3::Ipv4Address::Serialize(), ns3::TagBuffer::Write(), ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

void ns3::Ipv4PacketInfoTag::SetAddress

(

Ipv4Address

addr

)

Definition at line 37 of file ipv4-packet-info-tag.cc.

References m_addr.

void ns3::Ipv4PacketInfoTag::SetLocalAddress

(

Ipv4Address

addr

)

Definition at line 49 of file ipv4-packet-info-tag.cc.

References m_spec_dst.

void ns3::Ipv4PacketInfoTag::SetRecvIf

(

uint32_t

ifindex

)

Definition at line 61 of file ipv4-packet-info-tag.cc.

References m_ifindex.

Referenced by ns3::Ipv4RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp().

Here is the caller graph for this function:

void ns3::Ipv4PacketInfoTag::SetTtl

(

uint8_t

ttl

)

Definition at line 73 of file ipv4-packet-info-tag.cc.

References m_ttl.

Member Data Documentation

Ipv4Address ns3::Ipv4PacketInfoTag::m_addr

private

Definition at line 80 of file ipv4-packet-info-tag.h.

Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().

uint32_t ns3::Ipv4PacketInfoTag::m_ifindex

private

Definition at line 82 of file ipv4-packet-info-tag.h.

Referenced by Deserialize(), GetRecvIf(), Print(), Serialize(), and SetRecvIf().

Ipv4Address ns3::Ipv4PacketInfoTag::m_spec_dst

private

Definition at line 81 of file ipv4-packet-info-tag.h.

Referenced by Deserialize(), GetLocalAddress(), Print(), Serialize(), and SetLocalAddress().

uint8_t ns3::Ipv4PacketInfoTag::m_ttl

private

Definition at line 85 of file ipv4-packet-info-tag.h.

Referenced by Deserialize(), GetTtl(), Print(), Serialize(), and SetTtl().

---

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

• src/internet/model/ipv4-packet-info-tag.h
• src/internet/model/ipv4-packet-info-tag.cc