This class implements a tag that carries socket ancillary data to the socket interface. More...

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

Inheritance diagram for ns3::Ipv6PacketInfoTag:

Collaboration diagram for ns3::Ipv6PacketInfoTag:

Public Member Functions
	Ipv6PacketInfoTag ()

void	Deserialize (TagBuffer i) override

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

uint8_t	GetHoplimit () const
	Get the tag's Hop Limit.

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	GetTrafficClass () const
	Get the tag's Traffic Class.

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

void	Serialize (TagBuffer i) const override

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

void	SetHoplimit (uint8_t ttl)
	Set the tag's Hop Limit.

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

void	SetTrafficClass (uint8_t tclass)
	Set the tag's Traffic Class.

virtual void	Deserialize (TagBuffer i)=0

virtual uint32_t	GetSerializedSize () const =0

virtual void	Print (std::ostream &os) const =0

virtual void	Serialize (TagBuffer i) const =0

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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
Ipv6Address	m_addr
	the packet address (src or dst)

uint8_t	m_hoplimit
	the Hop Limit

uint8_t	m_ifindex
	the Interface index

uint8_t	m_tclass
	the Traffic Class

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 Functions 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 a tag that carries socket ancillary data to the socket interface.

This is used like socket option of IP_PKTINFO/IPV6_PKTINFO in RFC 3542

This tag in the send direction is presently not enabled but we would accept a patch along those lines in the future. To include the nexthop in the send direction would increase the size of the tag beyond 20 bytes, so in that case, we recommend that an additional tag be used to carry the IPv6 next hop address.

Definition at line 47 of file ipv6-packet-info-tag.h.

Constructor & Destructor Documentation

◆ Ipv6PacketInfoTag()

ns3::Ipv6PacketInfoTag::Ipv6PacketInfoTag ( )

Definition at line 29 of file ipv6-packet-info-tag.cc.

Member Function Documentation

◆ Deserialize()

void ns3::Ipv6PacketInfoTag::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 119 of file ipv6-packet-info-tag.cc.

References ns3::Ipv6Address::Deserialize(), m_addr, m_hoplimit, m_ifindex, m_tclass, ns3::TagBuffer::Read(), and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

◆ GetAddress()

Ipv6Address ns3::Ipv6PacketInfoTag::GetAddress ( ) const

Get the tag's address.

Returns: the address

Definition at line 44 of file ipv6-packet-info-tag.cc.

References m_addr.

Referenced by ns3::PacketSink::HandleRead(), and ns3::Ping::Receive().

Here is the caller graph for this function:

◆ GetHoplimit()

uint8_t ns3::Ipv6PacketInfoTag::GetHoplimit ( ) const

Get the tag's Hop Limit.

Returns: the Hop Limit

Definition at line 68 of file ipv6-packet-info-tag.cc.

References m_hoplimit.

◆ GetInstanceTypeId()

TypeId ns3::Ipv6PacketInfoTag::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.