ns3::Ipv4FlowProbeTag Class Reference

Tag used to allow a fast identification of the packet. More...

Inheritance diagram for ns3::Ipv4FlowProbeTag:

Collaboration diagram for ns3::Ipv4FlowProbeTag:

Public Member Functions
	Ipv4FlowProbeTag ()
	Ipv4FlowProbeTag (uint32_t flowId, uint32_t packetId, uint32_t packetSize)
	Consructor. More...
virtual void	Deserialize (TagBuffer buf)
uint32_t	GetFlowId (void) const
	Set the flow identifier. More...
virtual TypeId	GetInstanceTypeId (void) const
uint32_t	GetPacketId (void) const
	Set the packet identifier. More...
uint32_t	GetPacketSize (void) const
	Get the packet size. More...
virtual uint32_t	GetSerializedSize (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer buf) const
void	SetFlowId (uint32_t flowId)
	Set the flow identifier. More...
void	SetPacketId (uint32_t packetId)
	Set the packet identifier. More...
void	SetPacketSize (uint32_t packetSize)
	Set the packet size. 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 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
uint32_t	m_flowId
	flow identifier More...
uint32_t	m_packetId
	packet identifier More...
uint32_t	m_packetSize
	packet size More...

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

Tag used to allow a fast identification of the packet.

This tag is added by FlowMonitor when a packet is seen for the first time, and it is then used to classify the packet in the following hops.

Definition at line 48 of file ipv4-flow-probe.cc.

Constructor & Destructor Documentation

ns3::Ipv4FlowProbeTag::Ipv4FlowProbeTag

(

)

Definition at line 146 of file ipv4-flow-probe.cc.

ns3::Ipv4FlowProbeTag::Ipv4FlowProbeTag	(	uint32_t	flowId,
		uint32_t	packetId,
		uint32_t	packetSize
	)

Consructor.

Parameters

flowId	the flow identifier
packetId	the packet identifier
packetSize	the packet size

Definition at line 151 of file ipv4-flow-probe.cc.

Member Function Documentation

void ns3::Ipv4FlowProbeTag::Deserialize ( TagBuffer  i )

virtual

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 133 of file ipv4-flow-probe.cc.

References m_flowId, m_packetId, m_packetSize, and ns3::TagBuffer::ReadU32().

Here is the call graph for this function:

uint32_t ns3::Ipv4FlowProbeTag::GetFlowId

(

void

)

const

Set the flow identifier.

Returns

the flow identifier

Definition at line 172 of file ipv4-flow-probe.cc.

References m_flowId.

Referenced by ns3::Ipv4FlowProbe::DropLogger(), ns3::Ipv4FlowProbe::ForwardLogger(), ns3::Ipv4FlowProbe::ForwardUpLogger(), and ns3::Ipv4FlowProbe::QueueDropLogger().

Here is the caller graph for this function:

TypeId ns3::Ipv4FlowProbeTag::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 116 of file ipv4-flow-probe.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::Ipv4FlowProbeTag::GetPacketId

(

void

)

const

Set the packet identifier.

Returns

the packet identifier

Definition at line 177 of file ipv4-flow-probe.cc.

References m_packetId.

Referenced by ns3::Ipv4FlowProbe::DropLogger(), ns3::Ipv4FlowProbe::ForwardLogger(), ns3::Ipv4FlowProbe::ForwardUpLogger(), and ns3::Ipv4FlowProbe::QueueDropLogger().

Here is the caller graph for this function:

uint32_t ns3::Ipv4FlowProbeTag::GetPacketSize

(

void

)

const

Get the packet size.

Returns

the packet size

Definition at line 182 of file ipv4-flow-probe.cc.

References m_packetSize.

Referenced by ns3::Ipv4FlowProbe::QueueDropLogger().

Here is the caller graph for this function:

uint32_t ns3::Ipv4FlowProbeTag::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 121 of file ipv4-flow-probe.cc.

TypeId ns3::Ipv4FlowProbeTag::GetTypeId ( void  )

static

Get the type ID.

Returns

the object TypeId

Definition at line 107 of file ipv4-flow-probe.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::Ipv4FlowProbeTag::Print ( std::ostream &  os ) const

virtual

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 140 of file ipv4-flow-probe.cc.

References m_flowId, m_packetId, and m_packetSize.

void ns3::Ipv4FlowProbeTag::Serialize ( TagBuffer  i ) const

virtual

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 126 of file ipv4-flow-probe.cc.

References m_flowId, m_packetId, m_packetSize, and ns3::TagBuffer::WriteU32().

Here is the call graph for this function:

void ns3::Ipv4FlowProbeTag::SetFlowId

(

uint32_t

flowId

)

Set the flow identifier.

Parameters

flowId

the flow identifier

Definition at line 157 of file ipv4-flow-probe.cc.

References m_flowId.

void ns3::Ipv4FlowProbeTag::SetPacketId

(

uint32_t

packetId

)

Set the packet identifier.

Parameters

packetId

the packet identifier

Definition at line 162 of file ipv4-flow-probe.cc.

References m_packetId.

void ns3::Ipv4FlowProbeTag::SetPacketSize

(

uint32_t

packetSize

)

Set the packet size.

Parameters

packetSize

the packet size

Definition at line 167 of file ipv4-flow-probe.cc.

References m_packetSize.

Member Data Documentation

uint32_t ns3::Ipv4FlowProbeTag::m_flowId

private

flow identifier

Definition at line 100 of file ipv4-flow-probe.cc.

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

uint32_t ns3::Ipv4FlowProbeTag::m_packetId

private

packet identifier

Definition at line 101 of file ipv4-flow-probe.cc.

Referenced by Deserialize(), GetPacketId(), Print(), Serialize(), and SetPacketId().

uint32_t ns3::Ipv4FlowProbeTag::m_packetSize

private

packet size

Definition at line 102 of file ipv4-flow-probe.cc.

Referenced by Deserialize(), GetPacketSize(), Print(), Serialize(), and SetPacketSize().

---

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

• src/flow-monitor/model/ipv4-flow-probe.cc