This class implements Linux struct pktinfo in order to deliver ancillary information to the socket interface. More...
#include <ipv4-packet-info-tag.h>
Public Member Functions | |
Ipv4PacketInfoTag () | |
virtual void | Deserialize (TagBuffer i) |
Ipv4Address | GetAddress (void) const |
Get the tag's address. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Ipv4Address | GetLocalAddress (void) const |
Get the tag's local address. More... | |
uint32_t | GetRecvIf (void) const |
Get the tag's receiving interface. More... | |
virtual uint32_t | GetSerializedSize (void) const |
uint8_t | GetTtl (void) const |
Get the tag's Time to Live Implemented, but not used in the stack yet. More... | |
virtual void | Print (std::ostream &os) const |
virtual void | Serialize (TagBuffer i) const |
void | SetAddress (Ipv4Address addr) |
Set the tag's address. More... | |
void | SetLocalAddress (Ipv4Address addr) |
Set the tag's local address. More... | |
void | SetRecvIf (uint32_t ifindex) |
Set the tag's receiving interface. More... | |
void | SetTtl (uint8_t ttl) |
Set the tag's Time to Live Implemented, but not used in the stack yet. 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 | |
Ipv4Address | m_addr |
Header destination address. More... | |
uint32_t | m_ifindex |
interface index More... | |
Ipv4Address | m_spec_dst |
Local address. More... | |
uint8_t | m_ttl |
Time to Live. 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... | |
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.
ns3::Ipv4PacketInfoTag::Ipv4PacketInfoTag | ( | ) |
Definition at line 31 of file ipv4-packet-info-tag.cc.
References NS_LOG_FUNCTION.
|
virtual |
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 135 of file ipv4-packet-info-tag.cc.
References ns3::Ipv4Address::Deserialize(), m_addr, m_ifindex, m_spec_dst, m_ttl, NS_LOG_FUNCTION, ns3::TagBuffer::Read(), ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().
Ipv4Address ns3::Ipv4PacketInfoTag::GetAddress | ( | void | ) | const |
Get the tag's address.
Definition at line 48 of file ipv4-packet-info-tag.cc.
References m_addr, and NS_LOG_FUNCTION.
|
virtual |
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 GetTypeId(), and NS_LOG_FUNCTION.
Ipv4Address ns3::Ipv4PacketInfoTag::GetLocalAddress | ( | void | ) | const |
Get the tag's local address.
This corresponds to "ipi_spec_dst" in struct in_pktinfo. Implemented, but not used in the stack yet
Definition at line 62 of file ipv4-packet-info-tag.cc.
References m_spec_dst, and NS_LOG_FUNCTION.
uint32_t ns3::Ipv4PacketInfoTag::GetRecvIf | ( | void | ) | const |
Get the tag's receiving interface.
Definition at line 76 of file ipv4-packet-info-tag.cc.
References m_ifindex, and NS_LOG_FUNCTION.
Referenced by DynamicGlobalRoutingTestCase::HandleRead().
|
virtual |
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.
uint8_t ns3::Ipv4PacketInfoTag::GetTtl | ( | void | ) | const |
Get the tag's Time to Live Implemented, but not used in the stack yet.
Definition at line 90 of file ipv4-packet-info-tag.cc.
References m_ttl, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 99 of file ipv4-packet-info-tag.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
virtual |
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 147 of file ipv4-packet-info-tag.cc.
References m_addr, m_ifindex, m_spec_dst, m_ttl, and NS_LOG_FUNCTION.
|
virtual |
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 123 of file ipv4-packet-info-tag.cc.
References m_addr, m_ifindex, m_spec_dst, m_ttl, NS_LOG_FUNCTION, ns3::Ipv4Address::Serialize(), ns3::TagBuffer::Write(), ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().
void ns3::Ipv4PacketInfoTag::SetAddress | ( | Ipv4Address | addr | ) |
Set the tag's address.
addr | the address |
Definition at line 41 of file ipv4-packet-info-tag.cc.
References m_addr, and NS_LOG_FUNCTION.
void ns3::Ipv4PacketInfoTag::SetLocalAddress | ( | Ipv4Address | addr | ) |
Set the tag's local address.
This corresponds to "ipi_spec_dst" in struct in_pktinfo. Implemented, but not used in the stack yet
addr | the address |
Definition at line 55 of file ipv4-packet-info-tag.cc.
References m_spec_dst, and NS_LOG_FUNCTION.
void ns3::Ipv4PacketInfoTag::SetRecvIf | ( | uint32_t | ifindex | ) |
Set the tag's receiving interface.
ifindex | the interface index |
Definition at line 69 of file ipv4-packet-info-tag.cc.
References m_ifindex, and NS_LOG_FUNCTION.
Referenced by ns3::Ipv4RawSocketImpl::ForwardUp(), and ns3::UdpSocketImpl::ForwardUp().
void ns3::Ipv4PacketInfoTag::SetTtl | ( | uint8_t | ttl | ) |
Set the tag's Time to Live Implemented, but not used in the stack yet.
ttl | the TTL |
Definition at line 83 of file ipv4-packet-info-tag.cc.
References m_ttl, and NS_LOG_FUNCTION.
|
private |
Header destination address.
Definition at line 124 of file ipv4-packet-info-tag.h.
Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().
|
private |
interface index
Definition at line 126 of file ipv4-packet-info-tag.h.
Referenced by Deserialize(), GetRecvIf(), Print(), Serialize(), and SetRecvIf().
|
private |
Local address.
Definition at line 125 of file ipv4-packet-info-tag.h.
Referenced by Deserialize(), GetLocalAddress(), Print(), Serialize(), and SetLocalAddress().
|
private |
Time to Live.
Definition at line 129 of file ipv4-packet-info-tag.h.
Referenced by Deserialize(), GetTtl(), Print(), Serialize(), and SetTtl().