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

This class implements Linux struct pktinfo in order to deliver ancillary information to the socket interface. This is used with socket option such as IP_PKTINFO, IP_RECVTTL, IP_RECVTOS. See linux manpage ip(7). More...

#include <ipv4-packet-info-tag.h>

+ Inheritance diagram for ns3::Ipv4PacketInfoTag:

Public Member Functions

virtual void Deserialize (TagBuffer i)
 
Ipv4Address GetAddress (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
Ipv4Address GetLocalAddress (void) const
 
uint32_t GetRecvIf (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 SetAddress (Ipv4Address addr)
 
void SetLocalAddress (Ipv4Address addr)
 
void SetRecvIf (uint32_t ifindex)
 
void SetTtl (uint8_t ttl)
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Attributes

Ipv4Address m_addr
 
uint32_t m_ifindex
 
Ipv4Address m_spec_dst
 
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 Linux struct pktinfo in order to deliver ancillary information to the socket interface. This is used with socket option such as IP_PKTINFO, IP_RECVTTL, IP_RECVTOS. See linux manpage ip(7).

This tag in the send direction is presently not enabled but we would accept a patch along those lines in the future.

Definition at line 42 of file ipv4-packet-info-tag.h.

Member Function Documentation

void ns3::Ipv4PacketInfoTag::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 135 of file ipv4-packet-info-tag.cc.

References ns3::Ipv4Address::Deserialize(), NS_LOG_FUNCTION, ns3::TagBuffer::Read(), ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().

TypeId ns3::Ipv4PacketInfoTag::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 108 of file ipv4-packet-info-tag.cc.

References NS_LOG_FUNCTION.

uint32_t ns3::Ipv4PacketInfoTag::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 115 of file ipv4-packet-info-tag.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4PacketInfoTag::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 147 of file ipv4-packet-info-tag.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4PacketInfoTag::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 123 of file ipv4-packet-info-tag.cc.

References NS_LOG_FUNCTION, ns3::Ipv4Address::Serialize(), ns3::TagBuffer::Write(), ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().


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