ns3::SocketIpTtlTag Class Reference

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

#include "socket.h"

Inheritance diagram for ns3::SocketIpTtlTag:

Collaboration diagram for ns3::SocketIpTtlTag:

Public Member Functions
	SocketIpTtlTag ()
void	Deserialize (TagBuffer i) override
TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.
uint32_t	GetSerializedSize () const override
uint8_t	GetTtl () const
	Get the tag's TTL.
void	Print (std::ostream &os) const override
void	Serialize (TagBuffer i) const override
void	SetTtl (uint8_t ttl)
	Set the tag's TTL.
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_ttl
	the ttl 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 TTL of a packet to the IP 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 1112 of file socket.h.

Constructor & Destructor Documentation

SocketIpTtlTag()

ns3::SocketIpTtlTag::SocketIpTtlTag

(

)

Definition at line 587 of file socket.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Deserialize()

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

References m_ttl, NS_LOG_FUNCTION, and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

GetInstanceTypeId()

TypeId ns3::SocketIpTtlTag::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 619 of file socket.cc.

References GetTypeId().

Here is the call graph for this function:

GetSerializedSize()

uint32_t ns3::SocketIpTtlTag::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 625 of file socket.cc.

References NS_LOG_FUNCTION.

GetTtl()

uint8_t ns3::SocketIpTtlTag::GetTtl

(

)

const

Get the tag's TTL.

Returns

the TTL

Definition at line 600 of file socket.cc.

References m_ttl, and NS_LOG_FUNCTION.

Referenced by ns3::Rip::Receive(), ReceivePacket(), ns3::aodv::RoutingProtocol::RecvReply(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::Ipv4L3ClickProtocol::Send(), and ns3::Ipv4L3Protocol::Send().

Here is the caller graph for this function:

GetTypeId()

TypeId ns3::SocketIpTtlTag::GetTypeId ( )

static

Get the type ID.

Returns

the object TypeId

Definition at line 609 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::SocketIpTtlTag::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 646 of file socket.cc.

References m_ttl, and NS_LOG_FUNCTION.

Serialize()

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

References m_ttl, NS_LOG_FUNCTION, and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

SetTtl()

void ns3::SocketIpTtlTag::SetTtl

(

uint8_t

ttl

)

Set the tag's TTL.

Parameters

ttl

the TTL

Definition at line 593 of file socket.cc.

References m_ttl, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::AddSocketTags(), ns3::Rip::DoSendRouteUpdate(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp(), ns3::Rip::HandleRequests(), ns3::dsr::DsrOptionRreq::Process(), ns3::aodv::RoutingProtocol::RecvError(), ns3::aodv::RoutingProtocol::RecvReply(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::Radvd::Send(), ns3::TcpSocketCongestedRouter::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::aodv::RoutingProtocol::SendReply(), ns3::aodv::RoutingProtocol::SendReplyAck(), ns3::aodv::RoutingProtocol::SendReplyByIntermediateNode(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrWhenBreaksLinkToNextHop(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::Rip::SendRouteRequest(), and ns3::Ipv4RawSocketImpl::SendTo().

Here is the caller graph for this function:

Member Data Documentation

m_ttl

uint8_t ns3::SocketIpTtlTag::m_ttl

private

the ttl carried by the tag

Definition at line 1153 of file socket.h.

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

---

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

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