A Discrete-Event Network Simulator
API
ns3::SimpleTag Class Reference

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

virtual void Deserialize (TagBuffer i)
 
Mac48Address GetDst (void) const
 Get the destination address. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint16_t GetProto (void) const
 Get the protocol number. More...
 
virtual uint32_t GetSerializedSize (void) const
 
Mac48Address GetSrc (void) const
 Get the source address. More...
 
void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetDst (Mac48Address dst)
 Set the destination address. More...
 
void SetProto (uint16_t proto)
 Set the protocol number. More...
 
void SetSrc (Mac48Address src)
 Set the source address. 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

Mac48Address m_dst
 destination address More...
 
uint16_t m_protocolNumber
 protocol number More...
 
Mac48Address m_src
 source address 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

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 41 of file simple-net-device.cc.

Member Function Documentation

◆ Deserialize()

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

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

+ Here is the call graph for this function:

◆ GetDst()

Mac48Address ns3::SimpleTag::GetDst ( void  ) const

Get the destination address.

Returns
the destination address

Definition at line 159 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 ( 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 109 of file simple-net-device.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetProto()

uint16_t ns3::SimpleTag::GetProto ( void  ) const

Get the protocol number.

Returns
the protocol number

Definition at line 171 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 ( 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 115 of file simple-net-device.cc.

◆ GetSrc()

Mac48Address ns3::SimpleTag::GetSrc ( void  ) const

Get the source address.

Returns
the source address

Definition at line 147 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 ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 99 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
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 177 of file simple-net-device.cc.

References m_dst, m_protocolNumber, and m_src.

◆ Serialize()

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

References ns3::Mac48Address::CopyTo(), m_dst, m_protocolNumber, m_src, third::mac, 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
dstdestination address

Definition at line 153 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
protoprotocol number

Definition at line 165 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
srcsource address

Definition at line 141 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 91 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 92 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 90 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: