ns3::PacketSocketTag Class Reference

This class implements a tag that carries the dest address of a packet and the packet type. More...

#include <packet-socket.h>

Inheritance diagram for ns3::PacketSocketTag:

Collaboration diagram for ns3::PacketSocketTag:

Public Member Functions
	PacketSocketTag ()
	Create an empty PacketSocketTag. More...
virtual void	Deserialize (TagBuffer i)
Address	GetDestAddress (void) const
	Get the destination address of the corresponding packet. More...
virtual TypeId	GetInstanceTypeId (void) const
NetDevice::PacketType	GetPacketType (void) const
	Get the packet type. More...
virtual uint32_t	GetSerializedSize (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetDestAddress (Address a)
	Set the destination address of the corresponding packet. More...
void	SetPacketType (NetDevice::PacketType t)
	Set the packet type. 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)
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
Address	m_destAddr
std::string	m_deviceName
NetDevice::PacketType	m_packetType

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...

Detailed Description

This class implements a tag that carries the dest address of a packet and the packet type.

Doxygen introspection did not find any typical Config paths.

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

Definition at line 148 of file packet-socket.h.

Constructor & Destructor Documentation

ns3::PacketSocketTag::PacketSocketTag

(

)

Create an empty PacketSocketTag.

Definition at line 512 of file packet-socket.cc.

Member Function Documentation

void ns3::PacketSocketTag::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.

Definition at line 569 of file packet-socket.cc.

References ns3::Address::Deserialize(), m_destAddr, m_packetType, and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

Address ns3::PacketSocketTag::GetDestAddress

(

void

)

const

Get the destination address of the corresponding packet.

Returns

the destination address of the corresponding packet

Definition at line 535 of file packet-socket.cc.

References m_destAddr.

TypeId ns3::PacketSocketTag::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 553 of file packet-socket.cc.

References GetTypeId().

Here is the call graph for this function:

NetDevice::PacketType ns3::PacketSocketTag::GetPacketType

(

void

)

const

Get the packet type.

Returns

the packet type of the corresponding packet

Definition at line 523 of file packet-socket.cc.

References m_packetType.

uint32_t ns3::PacketSocketTag::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 558 of file packet-socket.cc.

References ns3::Address::GetSerializedSize(), and m_destAddr.

Here is the call graph for this function:

TypeId ns3::PacketSocketTag::GetTypeId ( void  )

static

Definition at line 544 of file packet-socket.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::PacketSocketTag::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.

Definition at line 575 of file packet-socket.cc.

References m_packetType.

void ns3::PacketSocketTag::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.

Definition at line 563 of file packet-socket.cc.

References m_destAddr, m_packetType, ns3::Address::Serialize(), and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

void ns3::PacketSocketTag::SetDestAddress

(

Address

a

)

Set the destination address of the corresponding packet.

Parameters

a	the destination address of the corresponding packet

Definition at line 529 of file packet-socket.cc.

References m_destAddr.

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

Here is the caller graph for this function:

void ns3::PacketSocketTag::SetPacketType

(

NetDevice::PacketType

t

)

Set the packet type.

Parameters

t	the packet type of the corresponding packet

Definition at line 517 of file packet-socket.cc.

References m_packetType.

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

Here is the caller graph for this function:

Member Data Documentation

Address ns3::PacketSocketTag::m_destAddr

private

Definition at line 186 of file packet-socket.h.

Referenced by Deserialize(), GetDestAddress(), GetSerializedSize(), Serialize(), and SetDestAddress().

std::string ns3::PacketSocketTag::m_deviceName

private

Definition at line 184 of file packet-socket.h.

NetDevice::PacketType ns3::PacketSocketTag::m_packetType

private

Definition at line 185 of file packet-socket.h.

Referenced by Deserialize(), GetPacketType(), Print(), Serialize(), and SetPacketType().

---

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

• src/network/utils/packet-socket.h
• src/network/utils/packet-socket.cc