This class implements a tag that carries the socket-specific HOPLIMIT of a packet to the IPv6 layer. More...

#include "socket.h"

Inheritance diagram for ns3::SocketIpv6HopLimitTag:

Collaboration diagram for ns3::SocketIpv6HopLimitTag:

Public Member Functions
	SocketIpv6HopLimitTag ()

void	Deserialize (TagBuffer i) override

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

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

uint32_t	GetSerializedSize () const override

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

void	Serialize (TagBuffer i) const override

void	SetHopLimit (uint8_t hopLimit)
	Set the tag's Hop Limit.

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
uint8_t	m_hopLimit
	the Hop Limit carried by the tag

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 a tag that carries the socket-specific HOPLIMIT of a packet to the IPv6 layer.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Network

Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 1160 of file socket.h.

Constructor & Destructor Documentation

◆ SocketIpv6HopLimitTag()

ns3::SocketIpv6HopLimitTag::SocketIpv6HopLimitTag ( )

Definition at line 652 of file socket.cc.

Member Function Documentation

◆ Deserialize()

void ns3::SocketIpv6HopLimitTag::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 699 of file socket.cc.

References m_hopLimit, and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

◆ GetHopLimit()

uint8_t ns3::SocketIpv6HopLimitTag::GetHopLimit ( ) const

Get the tag's Hop Limit.

Returns: the Hop Limit

Definition at line 663 of file socket.cc.

References m_hopLimit.

Referenced by ns3::RipNg::Receive(), ReceivePacket(), and ns3::Ipv6L3Protocol::Send().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

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

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 681 of file socket.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::SocketIpv6HopLimitTag::GetSerializedSize ( ) const

overridevirtual

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 687 of file socket.cc.

◆ GetTypeId()

TypeId ns3::SocketIpv6HopLimitTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 671 of file socket.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::SocketIpv6HopLimitTag::Print ( std::ostream & os ) const

overridevirtual

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 705 of file socket.cc.

References m_hopLimit.

◆ Serialize()

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

overridevirtual

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 693 of file socket.cc.

References m_hopLimit, and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

◆ SetHopLimit()

void ns3::SocketIpv6HopLimitTag::SetHopLimit ( uint8_t hopLimit )

Set the tag's Hop Limit.

Parameters

hopLimit the Hop Limit

Definition at line 657 of file socket.cc.

References m_hopLimit.

Referenced by ns3::TcpSocketBase::AddSocketTags(), ns3::RipNg::DoSendRouteUpdate(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv6RawSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp6(), ns3::RipNg::HandleRequests(), ns3::TcpSocketCongestedRouter::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), ns3::Icmpv6L4Protocol::SendMessage(), ns3::RipNg::SendRouteRequest(), and ns3::Ipv6RawSocketImpl::SendTo().

Here is the caller graph for this function:

Member Data Documentation

◆ m_hopLimit

uint8_t ns3::SocketIpv6HopLimitTag::m_hopLimit

private

the Hop Limit carried by the tag

Definition at line 1201 of file socket.h.

Referenced by Deserialize(), GetHopLimit(), Print(), Serialize(), and SetHopLimit().

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

src/network/model/socket.h
src/network/model/socket.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SocketIpv6HopLimitTag()

Member Function Documentation

◆ Deserialize()

◆ GetHopLimit()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetHopLimit()

Member Data Documentation

◆ m_hopLimit