SimpleNetDevice tag to store source, destination and protocol of each packet. More...

#include "introspected-doxygen.h"

Inheritance diagram for ns3::SimpleTag:

Collaboration diagram for ns3::SimpleTag:

Public Member Functions
void	Deserialize (TagBuffer i) override

Mac48Address	GetDst () const
	Get the destination address.

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

uint16_t	GetProto () const
	Get the protocol number.

uint32_t	GetSerializedSize () const override

Mac48Address	GetSrc () const
	Get the source address.

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

void	Serialize (TagBuffer i) const override

void	SetDst (Mac48Address dst)
	Set the destination address.

void	SetProto (uint16_t proto)
	Set the protocol number.

void	SetSrc (Mac48Address src)
	Set the source address.

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
Mac48Address	m_dst
	destination address

uint16_t	m_protocolNumber
	protocol number

Mac48Address	m_src
	source address

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

SimpleNetDevice tag to store source, destination and protocol of each packet.

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 24 bytes (on a 64-bit architecture).

Definition at line 43 of file simple-net-device.cc.

Member Function Documentation

◆ Deserialize()

void ns3::SimpleTag::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 134 of file simple-net-device.cc.

References ns3::Mac48Address::CopyFrom(), m_dst, m_protocolNumber, m_src, ns3::TagBuffer::Read(), and ns3::TagBuffer::ReadU16().

Here is the call graph for this function:

◆ GetDst()

Mac48Address ns3::SimpleTag::GetDst ( ) const

Get the destination address.

Returns: the destination address

Definition at line 163 of file simple-net-device.cc.

References m_dst.

Referenced by ns3::SimpleNetDevice::FinishTransmission().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SimpleTag::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 111 of file simple-net-device.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetProto()

uint16_t ns3::SimpleTag::GetProto ( ) const

Get the protocol number.

Returns: the protocol number

Definition at line 175 of file simple-net-device.cc.

References m_protocolNumber.

Referenced by ns3::SimpleNetDevice::FinishTransmission().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::SimpleTag::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 117 of file simple-net-device.cc.

◆ GetSrc()

Mac48Address ns3::SimpleTag::GetSrc ( ) const

Get the source address.

Returns: the source address

Definition at line 151 of file simple-net-device.cc.

References m_src.

Referenced by ns3::SimpleNetDevice::FinishTransmission().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SimpleTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 101 of file simple-net-device.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::SimpleTag::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 181 of file simple-net-device.cc.

References m_dst, m_protocolNumber, and m_src.

◆ Serialize()

void ns3::SimpleTag::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 123 of file simple-net-device.cc.

References ns3::Mac48Address::CopyTo(), m_dst, m_protocolNumber, m_src, ns3::TagBuffer::Write(), and ns3::TagBuffer::WriteU16().

Here is the call graph for this function:

◆ SetDst()

void ns3::SimpleTag::SetDst ( Mac48Address dst )

Set the destination address.

Parameters

dst	destination address

Definition at line 157 of file simple-net-device.cc.

References m_dst.

Referenced by ns3::SimpleNetDevice::SendFrom().

Here is the caller graph for this function:

◆ SetProto()

void ns3::SimpleTag::SetProto ( uint16_t proto )

Set the protocol number.

Parameters

proto protocol number

Definition at line 169 of file simple-net-device.cc.

References m_protocolNumber.

Referenced by ns3::SimpleNetDevice::SendFrom().

Here is the caller graph for this function:

◆ SetSrc()

void ns3::SimpleTag::SetSrc ( Mac48Address src )

Set the source address.

Parameters

src	source address

Definition at line 145 of file simple-net-device.cc.

References m_src.

Referenced by ns3::SimpleNetDevice::SendFrom().

Here is the caller graph for this function:

Member Data Documentation

◆ m_dst

Mac48Address ns3::SimpleTag::m_dst

private

destination address

Definition at line 94 of file simple-net-device.cc.

Referenced by Deserialize(), GetDst(), Print(), Serialize(), and SetDst().

◆ m_protocolNumber

uint16_t ns3::SimpleTag::m_protocolNumber

private

protocol number

Definition at line 95 of file simple-net-device.cc.

Referenced by Deserialize(), GetProto(), Print(), Serialize(), and SetProto().

◆ m_src

Mac48Address ns3::SimpleTag::m_src

private

source address

Definition at line 93 of file simple-net-device.cc.

Referenced by Deserialize(), GetSrc(), Print(), Serialize(), and SetSrc().

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

src/network/utils/simple-net-device.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ GetDst()

◆ GetInstanceTypeId()

◆ GetProto()

◆ GetSerializedSize()

◆ GetSrc()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetDst()

◆ SetProto()

◆ SetSrc()

Member Data Documentation

◆ m_dst

◆ m_protocolNumber

◆ m_src