This class implements a tag that carries socket ancillary data to the socket interface. More...
#include "ipv6-packet-info-tag.h"
Public Member Functions | |
Ipv6PacketInfoTag () | |
void | Deserialize (TagBuffer i) override |
Ipv6Address | GetAddress () const |
Get the tag's address. | |
uint8_t | GetHoplimit () const |
Get the tag's Hop Limit. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetRecvIf () const |
Get the tag's receiving interface. | |
uint32_t | GetSerializedSize () const override |
uint8_t | GetTrafficClass () const |
Get the tag's Traffic Class. | |
void | Print (std::ostream &os) const override |
void | Serialize (TagBuffer i) const override |
void | SetAddress (Ipv6Address addr) |
Set the tag's address. | |
void | SetHoplimit (uint8_t ttl) |
Set the tag's Hop Limit. | |
void | SetRecvIf (uint32_t ifindex) |
Set the tag's receiving interface. | |
void | SetTrafficClass (uint8_t tclass) |
Set the tag's Traffic Class. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Tag | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
Ipv6Address | m_addr |
the packet address (src or dst) | |
uint8_t | m_hoplimit |
the Hop Limit | |
uint8_t | m_ifindex |
the Interface index | |
uint8_t | m_tclass |
the Traffic Class | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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 also SocketIpv6TclassTag and SocketIpv6HopLimitTag
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 36 of file ipv6-packet-info-tag.h.
ns3::Ipv6PacketInfoTag::Ipv6PacketInfoTag | ( | ) |
Definition at line 18 of file ipv6-packet-info-tag.cc.
|
overridevirtual |
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 108 of file ipv6-packet-info-tag.cc.
References ns3::Ipv6Address::Deserialize(), m_addr, m_hoplimit, m_ifindex, m_tclass, ns3::TagBuffer::Read(), and ns3::TagBuffer::ReadU8().
Ipv6Address ns3::Ipv6PacketInfoTag::GetAddress | ( | ) | const |
Get the tag's address.
Definition at line 33 of file ipv6-packet-info-tag.cc.
References m_addr.
Referenced by ns3::PacketSink::HandleRead(), and ns3::Ping::Receive().
uint8_t ns3::Ipv6PacketInfoTag::GetHoplimit | ( | ) | const |
Get the tag's Hop Limit.
Definition at line 57 of file ipv6-packet-info-tag.cc.
References m_hoplimit.
|
overridevirtual |
Get the most derived TypeId for this Object.
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 85 of file ipv6-packet-info-tag.cc.
References GetTypeId().
uint32_t ns3::Ipv6PacketInfoTag::GetRecvIf | ( | ) | const |
Get the tag's receiving interface.
Definition at line 45 of file ipv6-packet-info-tag.cc.
References m_ifindex.
Referenced by ns3::Radvd::HandleRead(), and ns3::RipNg::Receive().
|
overridevirtual |
This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.
Implements ns3::Tag.
Definition at line 91 of file ipv6-packet-info-tag.cc.
uint8_t ns3::Ipv6PacketInfoTag::GetTrafficClass | ( | ) | const |
Get the tag's Traffic Class.
Definition at line 69 of file ipv6-packet-info-tag.cc.
References m_tclass.
|
static |
Get the type ID.
Definition at line 75 of file ipv6-packet-info-tag.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
os | the stream to print to |
This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.
Implements ns3::Tag.
Definition at line 119 of file ipv6-packet-info-tag.cc.
References m_addr, m_hoplimit, m_ifindex, and m_tclass.
|
overridevirtual |
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 97 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().
void ns3::Ipv6PacketInfoTag::SetAddress | ( | Ipv6Address | addr | ) |
Set the tag's address.
addr | the address |
Definition at line 27 of file ipv6-packet-info-tag.cc.
References m_addr.
Referenced by ns3::Ipv6RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp6().
void ns3::Ipv6PacketInfoTag::SetHoplimit | ( | uint8_t | ttl | ) |
Set the tag's Hop Limit.
ttl | the hop limit |
Definition at line 51 of file ipv6-packet-info-tag.cc.
References m_hoplimit.
Referenced by ns3::Ipv6RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp6().
void ns3::Ipv6PacketInfoTag::SetRecvIf | ( | uint32_t | ifindex | ) |
Set the tag's receiving interface.
ifindex | the interface index |
Definition at line 39 of file ipv6-packet-info-tag.cc.
References m_ifindex.
Referenced by ns3::Ipv6RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp6().
void ns3::Ipv6PacketInfoTag::SetTrafficClass | ( | uint8_t | tclass | ) |
Set the tag's Traffic Class.
tclass | the Traffic Class |
Definition at line 63 of file ipv6-packet-info-tag.cc.
References m_tclass.
Referenced by ns3::Ipv6RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp6().
|
private |
the packet address (src or dst)
Definition at line 126 of file ipv6-packet-info-tag.h.
Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().
|
private |
the Hop Limit
Definition at line 128 of file ipv6-packet-info-tag.h.
Referenced by Deserialize(), GetHoplimit(), Print(), Serialize(), and SetHoplimit().
|
private |
the Interface index
Definition at line 127 of file ipv6-packet-info-tag.h.
Referenced by Deserialize(), GetRecvIf(), Print(), Serialize(), and SetRecvIf().
|
private |
the Traffic Class
Definition at line 129 of file ipv6-packet-info-tag.h.
Referenced by Deserialize(), GetTrafficClass(), Print(), Serialize(), and SetTrafficClass().