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>
Public Member Functions | |
| void | SetAddress (Ipv4Address addr) |
| Ipv4Address | GetAddress (void) const |
| void | SetLocalAddress (Ipv4Address addr) |
| Ipv4Address | GetLocalAddress (void) const |
| void | SetRecvIf (uint32_t ifindex) |
| uint32_t | GetRecvIf (void) const |
| void | SetTtl (uint8_t ttl) |
| uint8_t | GetTtl (void) const |
| virtual TypeId | GetInstanceTypeId (void) const |
| virtual uint32_t | GetSerializedSize (void) const |
| virtual void | Serialize (TagBuffer i) const |
| virtual void | Deserialize (TagBuffer i) |
| virtual void | Print (std::ostream &os) const |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| This method returns the TypeId associated to ns3::Tag. | |
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.
Member Function Documentation
| void ns3::Ipv4PacketInfoTag::Deserialize | ( | TagBuffer | i | ) | [virtual] |
- Parameters:
-
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.
References ns3::Ipv4Address::Deserialize(), 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.
References GetTypeId().
| 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.
| TypeId ns3::Ipv4PacketInfoTag::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.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
| void ns3::Ipv4PacketInfoTag::Print | ( | std::ostream & | os | ) | const [virtual] |
- Parameters:
-
os the stream to print to
This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.
Implements ns3::Tag.
| void ns3::Ipv4PacketInfoTag::Serialize | ( | TagBuffer | i | ) | const [virtual] |
- Parameters:
-
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.
References ns3::Ipv4Address::Serialize(), ns3::TagBuffer::Write(), ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().
The documentation for this class was generated from the following files:
- src/internet/model/ipv4-packet-info-tag.h
- src/internet/model/ipv4-packet-info-tag.cc
