A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::FlowIdTag Class Reference

Doxygen introspection did not find any typical Config paths. 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. More...
 
virtual void Deserialize (TagBuffer buf)
 
uint32_t GetFlowId (void) const
 Gets the flow id for the tag. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer buf) const
 
void SetFlowId (uint32_t flowId)
 Sets the flow id for the tag. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static uint32_t AllocateFlowId (void)
 Uses a static variable to generate sequential flow id. More...
 
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint32_t m_flowId
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Doxygen introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::FlowIdTag::FlowIdTag ( )

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

References NS_LOG_FUNCTION.

ns3::FlowIdTag::FlowIdTag ( uint32_t  flowId)

Constructs a FlowIdTag with the given flow id.

Parameters
flowIdId to use for the tag

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

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::FlowIdTag::AllocateFlowId ( void  )
static

Uses a static variable to generate sequential flow id.

Returns
flow id allocated

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

References NS_LOG_FUNCTION_NOARGS.

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

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

+ Here is the call graph for this function:

uint32_t ns3::FlowIdTag::GetFlowId ( void  ) const

Gets the flow id for the tag.

Returns
current flow id for this tag

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

TypeId ns3::FlowIdTag::GetInstanceTypeId ( void  ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

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

References NS_LOG_FUNCTION.

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

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

References m_flowId, and NS_LOG_FUNCTION.

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

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

+ Here is the call graph for this function:

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

Sets the flow id for the tag.

Parameters
flowIdId to assign to the tag

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

References m_flowId, and NS_LOG_FUNCTION.

Member Data Documentation

uint32_t ns3::FlowIdTag::m_flowId
private

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

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


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