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:
Inheritance graph
[legend]
Collaboration diagram for ns3::SocketIpTtlTag:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SocketIpTtlTag ()
void SetTtl (uint8_t ttl)
uint8_t GetTtl (void) const
virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (TagBuffer i) const
virtual void Deserialize (TagBuffer i)
virtual void Print (std::ostream &os) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::ObjectBase.

Private Attributes

uint8_t m_ttl

Detailed Description

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

Definition at line 539 of file socket.h.


Constructor & Destructor Documentation

ns3::SocketIpTtlTag::SocketIpTtlTag (  ) 

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

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

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

References GetTypeId().

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::AddTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 344 of file socket.cc.

uint8_t ns3::SocketIpTtlTag::GetTtl ( void   )  const

Definition at line 322 of file socket.cc.

References m_ttl.

Referenced by ns3::Ipv4L3Protocol::Send().

TypeId ns3::SocketIpTtlTag::GetTypeId ( void   )  [static]

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

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

Reimplemented from ns3::Tag.

Definition at line 329 of file socket.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::SocketIpTtlTag::Print ( std::ostream &  os  )  const [virtual]
Parameters:
os the stream to print to

This method is typically invoked from the Packet::PrintTags method

Implements ns3::Tag.

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

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

void ns3::SocketIpTtlTag::SetTtl ( uint8_t  ttl  ) 

Definition at line 316 of file socket.cc.

References m_ttl.

Referenced by ns3::UdpSocketImpl::DoSendTo().


Member Data Documentation

uint8_t ns3::SocketIpTtlTag::m_ttl [private]

Definition at line 554 of file socket.h.

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


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:08 2009 for NS-3 by  doxygen 1.6.3