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
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetTtl (uint8_t ttl)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::SocketIpTtlTag.

Private Attributes
uint8_t	m_ttl

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

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

Definition at line 666 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketIpTtlTag::SocketIpTtlTag

(

)

Definition at line 410 of file socket.cc.

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

References m_ttl, 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 438 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 444 of file socket.cc.

uint8_t ns3::SocketIpTtlTag::GetTtl

(

void

)

const

Definition at line 421 of file socket.cc.

References m_ttl.

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

Here is the caller graph for this function:

TypeId ns3::SocketIpTtlTag::GetTypeId ( void  )

static

This method returns the TypeId associated to ns3::SocketIpTtlTag.

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

Reimplemented from ns3::Tag.

Definition at line 429 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 459 of file socket.cc.

References m_ttl.

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

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

Here is the call graph for this function:

void ns3::SocketIpTtlTag::SetTtl

(

uint8_t

ttl

)

Definition at line 415 of file socket.cc.

References m_ttl.

Referenced by ns3::UdpSocketImpl::DoSendTo(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::Radvd::Send(), 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

Definition at line 681 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
• doc/introspected-doxygen.h
• src/network/model/socket.cc