A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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
 Get the tag's Hop Limit. More...
 
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)
 Set the tag's Hop Limit. 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_hopLimit
 the Hop Limit 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 HOPLIMIT of a packet to the IPv6 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 1044 of file socket.h.

Constructor & Destructor Documentation

ns3::SocketIpv6HopLimitTag::SocketIpv6HopLimitTag ( )

Definition at line 640 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 685 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

Get the tag's Hop Limit.

Returns
the Hop Limit

Definition at line 651 of file socket.cc.

References m_hopLimit.

Referenced by ReceivePacket(), and 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 669 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 675 of file socket.cc.

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

Get the type ID.

Returns
the object TypeId

Definition at line 660 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 690 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 680 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)

Set the tag's Hop Limit.

Parameters
hopLimitthe Hop Limit

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

the Hop Limit carried by the tag

Definition at line 1085 of file socket.h.

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

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