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

This class implements a tag that carries socket ancillary data to the socket interface. This is used like socket option of IP_PKTINFO/IPV6_PKTINFO in RFC 3542 See: http://tools.ietf.org/html/rfc3542. More...

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

+ Inheritance diagram for ns3::Ipv6PacketInfoTag:
+ Collaboration diagram for ns3::Ipv6PacketInfoTag:

Public Member Functions

 Ipv6PacketInfoTag ()
virtual void Deserialize (TagBuffer i)
Ipv6Address GetAddress (void) const
uint8_t GetHoplimit (void) const
virtual TypeId GetInstanceTypeId (void) const
uint32_t GetRecvIf (void) const
virtual uint32_t GetSerializedSize (void) const
uint8_t GetTrafficClass (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (TagBuffer i) const
void SetAddress (Ipv6Address addr)
void SetHoplimit (uint8_t ttl)
void SetRecvIf (uint32_t ifindex)
void SetTrafficClass (uint8_t tclass)

Static Public Member Functions

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

Private Attributes

Ipv6Address m_addr
uint8_t m_hoplimit
uint8_t m_ifindex
uint8_t m_tclass

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 socket ancillary data to the socket interface. This is used like socket option of IP_PKTINFO/IPV6_PKTINFO in RFC 3542 See: http://tools.ietf.org/html/rfc3542.

This tag in the send direction is presently not enabled but we would accept a patch along those lines in the future. To include the nexthop in the send direction would increase the size of the tag beyond 20 bytes, so in that case, we recommend that an additional tag be used to carry the IPv6 next hop address.

Definition at line 45 of file ipv6-packet-info-tag.h.

Constructor & Destructor Documentation

ns3::Ipv6PacketInfoTag::Ipv6PacketInfoTag ( )

Definition at line 28 of file ipv6-packet-info-tag.cc.

Member Function Documentation

void ns3::Ipv6PacketInfoTag::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 119 of file ipv6-packet-info-tag.cc.

References m_addr, m_hoplimit, m_ifindex, m_tclass, ns3::TagBuffer::Read(), and ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

Ipv6Address ns3::Ipv6PacketInfoTag::GetAddress ( void  ) const

Definition at line 43 of file ipv6-packet-info-tag.cc.

References m_addr.

uint8_t ns3::Ipv6PacketInfoTag::GetHoplimit ( void  ) const

Definition at line 67 of file ipv6-packet-info-tag.cc.

References m_hoplimit.

TypeId ns3::Ipv6PacketInfoTag::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 95 of file ipv6-packet-info-tag.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::Ipv6PacketInfoTag::GetRecvIf ( void  ) const

Definition at line 55 of file ipv6-packet-info-tag.cc.

References m_ifindex.

uint32_t ns3::Ipv6PacketInfoTag::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 101 of file ipv6-packet-info-tag.cc.

uint8_t ns3::Ipv6PacketInfoTag::GetTrafficClass ( void  ) const

Definition at line 79 of file ipv6-packet-info-tag.cc.

References m_tclass.

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

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

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

Reimplemented from ns3::Tag.

Definition at line 86 of file ipv6-packet-info-tag.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::Ipv6PacketInfoTag::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 129 of file ipv6-packet-info-tag.cc.

References m_addr, m_hoplimit, m_ifindex, and m_tclass.

void ns3::Ipv6PacketInfoTag::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 109 of file ipv6-packet-info-tag.cc.

References m_addr, m_hoplimit, m_ifindex, m_tclass, ns3::Ipv6Address::Serialize(), ns3::TagBuffer::Write(), and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

void ns3::Ipv6PacketInfoTag::SetAddress ( Ipv6Address  addr)

Definition at line 37 of file ipv6-packet-info-tag.cc.

References m_addr.

void ns3::Ipv6PacketInfoTag::SetHoplimit ( uint8_t  ttl)

Definition at line 61 of file ipv6-packet-info-tag.cc.

References m_hoplimit.

void ns3::Ipv6PacketInfoTag::SetRecvIf ( uint32_t  ifindex)

Definition at line 49 of file ipv6-packet-info-tag.cc.

References m_ifindex.

Referenced by ns3::Ipv6RawSocketImpl::ForwardUp().

+ Here is the caller graph for this function:

void ns3::Ipv6PacketInfoTag::SetTrafficClass ( uint8_t  tclass)

Definition at line 73 of file ipv6-packet-info-tag.cc.

References m_tclass.

Member Data Documentation

Ipv6Address ns3::Ipv6PacketInfoTag::m_addr
private

Definition at line 87 of file ipv6-packet-info-tag.h.

Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().

uint8_t ns3::Ipv6PacketInfoTag::m_hoplimit
private

Definition at line 89 of file ipv6-packet-info-tag.h.

Referenced by Deserialize(), GetHoplimit(), Print(), Serialize(), and SetHoplimit().

uint8_t ns3::Ipv6PacketInfoTag::m_ifindex
private

Definition at line 88 of file ipv6-packet-info-tag.h.

Referenced by Deserialize(), GetRecvIf(), Print(), Serialize(), and SetRecvIf().

uint8_t ns3::Ipv6PacketInfoTag::m_tclass
private

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