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:

Collaboration diagram for ns3::DeviceNameTag:

Public Member Functions
	DeviceNameTag ()
	Create an empty DeviceNameTag.

void	Deserialize (TagBuffer i) override

std::string	GetDeviceName () const
	Get the device name from where the corresponding packet is coming.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint32_t	GetSerializedSize () const override

void	Print (std::ostream &os) const override

void	Serialize (TagBuffer i) const override

void	SetDeviceName (std::string n)
	Set the device name.

virtual void	Deserialize (TagBuffer i)=0

virtual uint32_t	GetSerializedSize () const =0

virtual void	Print (std::ostream &os) const =0

virtual void	Serialize (TagBuffer i) const =0

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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
std::string	m_deviceName
	Device name.

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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ DeviceNameTag()

ns3::DeviceNameTag::DeviceNameTag ( )

Create an empty DeviceNameTag.

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

Member Function Documentation

◆ Deserialize()

void ns3::DeviceNameTag::Deserialize ( TagBuffer i )

overridevirtual

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 669 of file packet-socket.cc.

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

Here is the call graph for this function:

◆ GetDeviceName()

std::string ns3::DeviceNameTag::GetDeviceName ( ) 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 628 of file packet-socket.cc.

References m_deviceName.

◆ GetInstanceTypeId()

TypeId ns3::DeviceNameTag::GetInstanceTypeId ( ) const

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.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::DeviceNameTag::GetSerializedSize ( ) const

overridevirtual

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 652 of file packet-socket.cc.

References m_deviceName.

◆ GetTypeId()

TypeId ns3::DeviceNameTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 636 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:

◆ Print()

void ns3::DeviceNameTag::Print ( std::ostream & os ) const

overridevirtual

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 679 of file packet-socket.cc.

References m_deviceName.

◆ Serialize()

void ns3::DeviceNameTag::Serialize ( TagBuffer i ) const

overridevirtual

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 659 of file packet-socket.cc.

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

Here is the call graph for this function:

◆ SetDeviceName()

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 618 of file packet-socket.cc.

References m_deviceName.

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_deviceName

std::string ns3::DeviceNameTag::m_deviceName

private

Device name.

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

Referenced by Deserialize(), GetDeviceName(), GetSerializedSize(), Print(), Serialize(), and SetDeviceName().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeviceNameTag()

Member Function Documentation

◆ Deserialize()

◆ GetDeviceName()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetDeviceName()

Member Data Documentation

◆ m_deviceName