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 ()
virtual void	Deserialize (TagBuffer i)
virtual TypeId	GetInstanceTypeId (void) const
virtual uint32_t	GetSerializedSize (void) const
uint8_t	GetTtl (void) const
	Get the tag's TTL. More...
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetTtl (uint8_t ttl)
	Set the tag's TTL. More...
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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

Private Attributes
uint8_t	m_ttl
	the ttl carried by the tag More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

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

Doxygen introspection did not find any typical Config paths.

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

Definition at line 996 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketIpTtlTag::SocketIpTtlTag

(

)

Definition at line 578 of file socket.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

Here is the call graph for this function:

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

References GetTypeId().

Here is the call graph for this function:

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

References NS_LOG_FUNCTION.

uint8_t ns3::SocketIpTtlTag::GetTtl

(

void

)

const

Get the tag's TTL.

Returns

the TTL

Definition at line 591 of file socket.cc.

References m_ttl, and NS_LOG_FUNCTION.

Referenced by ReceivePacket(), and ns3::Ipv4L3Protocol::Send().

Here is the caller graph for this function:

TypeId ns3::SocketIpTtlTag::GetTypeId ( void  )

static

Get the type ID.

Returns

the object TypeId

Definition at line 601 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:

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

References m_ttl, and NS_LOG_FUNCTION.

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

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

Here is the call graph for this function:

void ns3::SocketIpTtlTag::SetTtl

(

uint8_t

ttl

)

Set the tag's TTL.

Parameters

ttl

the TTL

Definition at line 584 of file socket.cc.

References m_ttl, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::DoSendTo(), ns3::UdpSocketImpl::ForwardUp(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::Radvd::Send(), ns3::TcpSocketBase::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendInitialRequest(), and ns3::Icmpv6L4Protocol::SendMessage().

Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::SocketIpTtlTag::m_ttl

private

the ttl carried by the tag

Definition at line 1037 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