ns3::DeviceNameTag Class Reference

This class implements a tag that carries the ns3 device name from where a packet is coming. More...

#include <packet-socket.h>

Inheritance diagram for ns3::DeviceNameTag:

Public Member Functions
	DeviceNameTag ()
virtual void	Deserialize (TagBuffer i)
std::string	GetDeviceName (void) const
virtual TypeId	GetInstanceTypeId (void) const
virtual uint32_t	GetSerializedSize (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetDeviceName (std::string n)
Public Member Functions inherited from ns3::ObjectBase
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)

Private Attributes
std::string	m_deviceName

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 the ns3 device name from where a packet is coming.

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 192 of file packet-socket.h.

Constructor & Destructor Documentation

ns3::DeviceNameTag::DeviceNameTag

(

)

Create an empty DeviceNameTag

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

Member Function Documentation

void ns3::DeviceNameTag::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 635 of file packet-socket.cc.

References ns3::TagBuffer::Read(), and ns3::TagBuffer::ReadU8().

std::string ns3::DeviceNameTag::GetDeviceName

(

void

)

const

Get the device name from where the corresponding packet is coming.

Returns

the device name from where the corresponding packet is coming.

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

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

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

References PACKET_TAG_MAX_SIZE.

void ns3::DeviceNameTag::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 644 of file packet-socket.cc.

void ns3::DeviceNameTag::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 624 of file packet-socket.cc.

References PACKET_TAG_MAX_SIZE, ns3::TagBuffer::Write(), and ns3::TagBuffer::WriteU8().

void ns3::DeviceNameTag::SetDeviceName

(

std::string

n

)

Set the device name

Parameters

n	the device name from where the corresponding packet is coming.

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

---

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

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