This class implements Linux struct pktinfo in order to deliver ancillary information to the socket interface. More...

#include "ipv4-packet-info-tag.h"

Inheritance diagram for ns3::Ipv4PacketInfoTag:

Collaboration diagram for ns3::Ipv4PacketInfoTag:

Public Member Functions
	Ipv4PacketInfoTag ()

void	Deserialize (TagBuffer i) override

Ipv4Address	GetAddress () const
	Get the tag's address.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetRecvIf () const
	Get the tag's receiving interface.

uint32_t	GetSerializedSize () const override

uint8_t	GetTtl () const
	Get the tag's Time to Live Implemented, but not used in the stack yet.

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

void	Serialize (TagBuffer i) const override

void	SetAddress (Ipv4Address addr)
	Set the tag's address.

void	SetRecvIf (uint32_t ifindex)
	Set the tag's receiving interface.

void	SetTtl (uint8_t ttl)
	Set the tag's Time to Live Implemented, but not used in the stack yet.

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 type ID.

Static Public Member Functions inherited from ns3::Tag
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
Ipv4Address	m_addr
	Header destination address.

uint32_t	m_ifindex
	interface index

uint8_t	m_ttl
	Time to Live.

Additional Inherited Members
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.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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).

See also SocketIpTosTag and SocketIpTtlTag

The Tag does not carry the Local address (as it is not currently used to force a source address).

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 37 of file ipv4-packet-info-tag.h.

Constructor & Destructor Documentation

◆ Ipv4PacketInfoTag()

ns3::Ipv4PacketInfoTag::Ipv4PacketInfoTag ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

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

overridevirtual

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 107 of file ipv4-packet-info-tag.cc.

References ns3::Ipv4Address::Deserialize(), m_addr, m_ifindex, m_ttl, NS_LOG_FUNCTION, ns3::TagBuffer::Read(), ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

◆ GetAddress()

Ipv4Address ns3::Ipv4PacketInfoTag::GetAddress ( ) const

Get the tag's address.

Returns: the address

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

References m_addr, and NS_LOG_FUNCTION.

Referenced by ns3::PacketSink::HandleRead().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Ipv4PacketInfoTag::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.