Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Network
Size of this type is 16 bytes (on a 64-bit architecture). More...

#include "flow-id-tag.h"

Inheritance diagram for ns3::FlowIdTag:

Collaboration diagram for ns3::FlowIdTag:

Public Member Functions
	FlowIdTag ()
	FlowIdTag (uint32_t flowId)
	Constructs a FlowIdTag with the given flow id.
void	Deserialize (TagBuffer buf) override
uint32_t	GetFlowId () const
	Gets the flow id for the tag.
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 buf) const override
void	SetFlowId (uint32_t flowId)
	Sets the flow id for the tag.
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.
void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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.
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 uint32_t	AllocateFlowId ()
	Uses a static variable to generate sequential flow id.
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
uint32_t	m_flowId
	Flow ID.

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

Detailed Description

Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Network
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 16 of file flow-id-tag.h.

Constructor & Destructor Documentation

◆ FlowIdTag() [1/2]

ns3::FlowIdTag::FlowIdTag ( )

Definition at line 63 of file flow-id-tag.cc.

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ FlowIdTag() [2/2]

ns3::FlowIdTag::FlowIdTag ( uint32_t flowId )

Constructs a FlowIdTag with the given flow id.

Parameters

flowId Id to use for the tag

Definition at line 69 of file flow-id-tag.cc.

References m_flowId, and NS_LOG_FUNCTION.

Member Function Documentation

◆ AllocateFlowId()

uint32_t ns3::FlowIdTag::AllocateFlowId ( )

static

Uses a static variable to generate sequential flow id.

Returns: flow id allocated

Definition at line 91 of file flow-id-tag.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by CollisionExperiment::Run().

Here is the caller graph for this function:

◆ Deserialize()

void ns3::FlowIdTag::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 50 of file flow-id-tag.cc.

References m_flowId, NS_LOG_FUNCTION, and ns3::TagBuffer::ReadU32().

Here is the call graph for this function:

◆ GetFlowId()

uint32_t ns3::FlowIdTag::GetFlowId ( ) const

Gets the flow id for the tag.

Returns: current flow id for this tag

Definition at line 84 of file flow-id-tag.cc.

References m_flowId, and NS_LOG_FUNCTION.

Referenced by CollisionExperiment::Receive().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::FlowIdTag::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

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

Implements ns3::ObjectBase.

Definition at line 30 of file flow-id-tag.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::FlowIdTag::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 36 of file flow-id-tag.cc.

References NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::FlowIdTag::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 20 of file flow-id-tag.cc.

References FlowIdTag(), and 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::FlowIdTag::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 57 of file flow-id-tag.cc.

References m_flowId, and NS_LOG_FUNCTION.

◆ Serialize()

void ns3::FlowIdTag::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 43 of file flow-id-tag.cc.

References m_flowId, NS_LOG_FUNCTION, and ns3::TagBuffer::WriteU32().

Here is the call graph for this function:

◆ SetFlowId()

void ns3::FlowIdTag::SetFlowId ( uint32_t flowId )

Sets the flow id for the tag.

Parameters

flowId Id to assign to the tag

Definition at line 77 of file flow-id-tag.cc.

References m_flowId, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_flowId

uint32_t ns3::FlowIdTag::m_flowId

private

Flow ID.

Definition at line 54 of file flow-id-tag.h.

Referenced by FlowIdTag(), Deserialize(), GetFlowId(), Print(), Serialize(), and SetFlowId().

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

src/network/utils/flow-id-tag.h
src/network/utils/flow-id-tag.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FlowIdTag() [1/2]

◆ FlowIdTag() [2/2]

Member Function Documentation

◆ AllocateFlowId()

◆ Deserialize()

◆ GetFlowId()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetFlowId()

Member Data Documentation

◆ m_flowId