A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SocketIpv6HopLimitTag Class Reference

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 ()
virtual void Deserialize (TagBuffer i)
uint8_t GetHopLimit (void) const
virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (TagBuffer i) const
void SetHopLimit (uint8_t hopLimit)

Static Public Member Functions

static TypeId GetTypeId (void)

Private Attributes

uint8_t m_hopLimit

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 HOPLIMIT of a packet to the IPv6 layer.

This type is not accessible from the Config system.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 891 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketIpv6HopLimitTag::SocketIpv6HopLimitTag ( )

Definition at line 637 of file socket.cc.

Member Function Documentation

void ns3::SocketIpv6HopLimitTag::Deserialize ( TagBuffer  i)
virtual
Parameters
ithe 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 681 of file socket.cc.

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

+ Here is the call graph for this function:

uint8_t ns3::SocketIpv6HopLimitTag::GetHopLimit ( void  ) const

Definition at line 648 of file socket.cc.

References m_hopLimit.

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

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

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

TypeId ns3::SocketIpv6HopLimitTag::GetTypeId ( void  )
static

Reimplemented from ns3::Tag.

Definition at line 656 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::SocketIpv6HopLimitTag::Print ( std::ostream &  os) const
virtual
Parameters
osthe stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 686 of file socket.cc.

References m_hopLimit.

void ns3::SocketIpv6HopLimitTag::Serialize ( TagBuffer  i) const
virtual
Parameters
ithe 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 676 of file socket.cc.

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

+ Here is the call graph for this function:

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

Definition at line 642 of file socket.cc.

References m_hopLimit.

Referenced by ns3::UdpSocketImpl::DoSendTo(), ns3::UdpSocketImpl::ForwardUp6(), ns3::TcpSocketBase::SendDataPacket(), and ns3::TcpSocketBase::SendEmptyPacket().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::SocketIpv6HopLimitTag::m_hopLimit
private

Definition at line 906 of file socket.h.

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


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