A Discrete-Event Network Simulator
API
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:
+ Collaboration diagram for ns3::DeviceNameTag:

Public Member Functions

 DeviceNameTag ()
 Create an empty DeviceNameTag. More...
 
virtual void Deserialize (TagBuffer i)
 
std::string GetDeviceName (void) const
 Get the device name from where the corresponding packet is coming. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetDeviceName (std::string n)
 Set the device name. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::string m_deviceName
 Device name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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

Constructor & Destructor Documentation

◆ DeviceNameTag()

ns3::DeviceNameTag::DeviceNameTag ( )

Create an empty DeviceNameTag.

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

Member Function Documentation

◆ Deserialize()

void ns3::DeviceNameTag::Deserialize ( TagBuffer  i)
virtual
Parameters
ithe 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 659 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 ( 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 622 of file packet-socket.cc.

References m_deviceName.

◆ GetInstanceTypeId()

TypeId ns3::DeviceNameTag::GetInstanceTypeId ( void  ) const
virtual

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

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

References m_deviceName.

◆ GetTypeId()

TypeId ns3::DeviceNameTag::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 630 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
virtual
Parameters
osthe stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

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

References m_deviceName.

◆ Serialize()

void ns3::DeviceNameTag::Serialize ( TagBuffer  i) const
virtual
Parameters
ithe 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 650 of file packet-socket.cc.

References m_deviceName, sample-rng-plot::n, 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
nthe device name from where the corresponding packet is coming.

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

References m_deviceName, and sample-rng-plot::n.

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 294 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: