Flow Class Reference

Class representing flow object with attributes from specs. More...

#include <Flow.h>

Inheritance diagram for Flow:

Public Member Functions
	Flow ()
	Constructor for the flow with undefined values. More...
	Flow (APNamingInfo src, APNamingInfo dst)
	Default constructor for flow between two applications. More...
virtual	~Flow ()
	Destructor assigning default uninitialized values. More...
bool	operator== (const Flow &other) const
	Equal operator overloading. More...
bool	compare (const Flow &other) const
	Comparator taking into account src/dst addresses, src/dst APNIs, src-dst ConIds/PortIds. More...
virtual Flow *	dup () const
	Flow object duplication method that creates copy with. More...
Flow *	dupToMgmt () const
std::string	info () const
	Prints Flow information as string Calls variety of other info functions to produce final output. More...
std::string	infoSource () const
	Prints Flow source information as string Outputs source APNI, address, neigbor-address, PortId, CEP-Id. More...
std::string	infoDestination () const
	Prints Flow destination information as string Outputs destination APNI, address, neigbor-address, PortId, CEP-Id. More...
std::string	infoOther () const
	Prints Flow create flow information and hop-cpunt as string. More...
std::string	infoQoS () const
	Prints RA's QoSCube-id that FA choosed during Flow allocation phase Accompanied QoSParameters could be find in AE that starts communication. They are omitted in order to make debug outputs more readable. More...
std::string	getFlowName () const
	Prints flow name consisting of source and destination APNI Primary use is for OMNeT++ cMessage property to easily recognize which message is which. More...
Flow &	swapFlow ()
	Function that swaps relevant source and destination Flow parameters It is being used mainly for counterpart communication during Flow (de)allocation. More...
ConnectionId &	getConnectionId ()
	Gets Flow's ConnectionId. More...
const ConnectionId &	getConId () const
	Gets read-only Flow's ConnectionId. More...
void	setConId (const ConnectionId &conId)
	Sets Flow's ConnectionId. More...
void	setQosCube (const QoSCube &qosCube)
const QoSCube &	getQosCube () const
const QoSReq &	getQosRequirements () const
	Gets QoS parameters wanted by flow initiator. More...
QoSReq &	getQosReqs ()
void	setQosRequirements (const QoSReq &qosReqs)
	Sets QoS parameters wanted by flow initiator. More...
const APNamingInfo &	getSrcApni () const
	Gets read-only source APNamingInfo. More...
void	setSrcApni (const APNamingInfo &srcApni)
	Sets source APNamingInfo. More...
const APNamingInfo &	getDstApni () const
	Gets read-only destination APNamingInfo. More...
void	setDstApni (const APNamingInfo &dstApni)
	Sets destination APNamingInfo. More...
int	getSrcPortId () const
	Gets source PortId. More...
void	setSrcPortId (int srcPortId)
	Sets source PortId. More...
int	getDstPortId () const
	Gets destination PortId. More...
void	setDstPortId (int dstPortId)
	Sets destination PortId. More...
uint32_t	getCreateFlowRetries () const
	Gets current number of CreateFlow retries During Flow allocation phase, CreateFlow is incremented each time M_CREATE(flow) is sent. More...
void	setCreateFlowRetries (uint32_t createFlowRetries)
	Sets current number of CreateFlow retries During Flow allocation phase, CreateFlow is incremented each time M_CREATE(flow) is sent. More...
uint32_t	getMaxCreateFlowRetries () const
	Gets maximum allowed number CreateFlow retries By default 3 (const VAL_MAXCREATERETRIES). Value is checked during Flow allocation. More...
void	setMaxCreateFlowRetries (uint32_t maxCreateFlowRetries)
	Sets maximum allowed number of CreateFlow retries. More...
uint32_t	getHopCount () const
	Gets hop-count, which is number of allowed message forwards from this device towards destination By default its initial value is 16 (const VAL_MAXHOPCOUNT). More...
void	setHopCount (uint32_t hopCount)
	Sets a new hop-count. Hop-count should be decremented each time message is forwarded within DIF. More...
const Address &	getSrcAddr () const
	Gets source Address, which is the address of communication start-point. More...
void	setSrcAddr (const Address &srcAddr)
	Sets (start-point) source Address. More...
const Address &	getDstAddr () const
	Gets source Address, which is the address of communication end-point. More...
void	setDstAddr (const Address &dstAddr)
	Sets (end-point) destination Address. More...
const Address &	getSrcNeighbor () const
	Gets neighbor source Address, which is the address of (interim) hop-by-hop source Used during flow allocation to pass the M_CREATE(_R)(flow) messages. More...
void	setSrcNeighbor (const Address &srcNeighbor)
	Sets neighbor source Address. More...
const Address &	getDstNeighbor () const
	Gets neighbor destination Address, which is the address of (interim) hop-by-hop destination Used during flow allocation to pass the M_CREATE(_R)(flow) messages. More...
void	setDstNeighbor (const Address &dstNeighbor)
	Sets neighbor destination Address. More...
long	getAllocInvokeId () const
	Gets allocation InvokeId Used inside M_CREATE(_R)(flow) messages. More...
void	setAllocInvokeId (long allocInvokeId)
	Sets allocation InvokeId. More...
long	getDeallocInvokeId () const
	Gets deallocation InvokeId Used inside M_DELETE(_R)(flow) messages. More...
void	setDeallocInvokeId (long deallocInvokeId)
	Sets deallocation InvokeId. More...
bool	isDdtFlag () const
	Gets whether flow is for Degenerate Data Transfer. More...
void	setDdtFlag (bool ddtFlag)
	Sets Degenerate Data Transfer flag. More...
bool	isManagementFlow () const
bool	isManagementFlowLocalToIPCP () const

Protected Member Functions
void	swapPortIds ()
	Auxiliary function swapping source and destination PortIds. More...
void	swapAddresses ()
	Auxiliary function swapping source and destination Addresses. More...
void	swapCepIds ()
	Auxiliary function swapping source and destination CEP-Ids. More...
void	swapApni ()
	Auxiliary function swapping source and destinatio APNI. More...

Protected Attributes
APNamingInfo	srcApni
	Attribute holding source APNI. More...
APNamingInfo	dstApni
	Attribute holding destination APNI. More...
int	srcPortId
	Attribute holding source PortId. More...
int	dstPortId
	Attribute holding destination PortId. More...
Address	srcAddr
	Attribute holding source address (initiator of communication) More...
Address	dstAddr
	Attribute holding destination address (end-host for communication) More...
Address	srcNeighbor
	Attribute holding hop-by-hop source address. More...
Address	dstNeighbor
	Attribute holding hop-by-hop destination address. More...
ConnectionId	conId
	Attribute holding ConnectionId containing source and destination CEP-Ids and chosen RA's QoSCube. More...
uint32_t	createFlowRetries
	Attribute holding current number of allowed CreateFlow retries. More...
uint32_t	maxCreateFlowRetries
	Attribute holding maximum allowed number of CreateFlow retries. More...
uint32_t	hopCount
	Attribute holding flow's hop-count. More...
QoSCube	qosCube
	Attribute holding the assigned QoSCube. More...
QoSReq	qosReqs
	Attribute holding wanted QoS parameters in form of QoSReq. More...
long	allocInvokeId
	Attribute holding persistant InvokeId used for allocation. More...
long	deallocInvokeId
	Attribute holding persistant InvokeId used for deallocation. More...
bool	ddtFlag
	Attribute representing whether flow is for Degenerate Data Transfer or not. More...

Detailed Description

Class representing flow object with attributes from specs.

Authors

Vladimir Vesely (ivese.nosp@m.ly@f.nosp@m.it.vu.nosp@m.tbr..nosp@m.cz)

Date

Last refactorized and documented on 2014-10-28

Definition at line 45 of file Flow.h.

Constructor & Destructor Documentation

Flow::Flow

(

)

Constructor for the flow with undefined values.

Definition at line 32 of file Flow.cc.

Referenced by dup().

Flow::Flow	(	APNamingInfo	src,
		APNamingInfo	dst
	)

Default constructor for flow between two applications.

Parameters

src	Source application naming info
dst	Destination application naming info

Definition at line 44 of file Flow.cc.

Flow::~Flow ( )

virtual

Destructor assigning default uninitialized values.

Definition at line 56 of file Flow.cc.

Member Function Documentation

bool Flow::compare

(

const Flow &

other

)

const

Comparator taking into account src/dst addresses, src/dst APNIs, src-dst ConIds/PortIds.

Definition at line 269 of file Flow.cc.

Referenced by LisFAIAllocReq::receiveSignal(), LisFAIDelRes::receiveSignal(), and LisFAIDelReq::receiveSignal().

Flow * Flow::dup ( ) const

virtual

Flow object duplication method that creates copy with.

Returns

Definition at line 182 of file Flow.cc.

Referenced by dupToMgmt(), FANotifier::processMCreate(), FANotifier::processMCreateR(), FANotifier::processMDelete(), FANotifier::processMDeleteR(), and FA::receiveNM1FlowCreated().

Flow * Flow::dupToMgmt

(

)

const

Definition at line 356 of file Flow.cc.

long Flow::getAllocInvokeId

(

)

const

Gets allocation InvokeId Used inside M_CREATE(_R)(flow) messages.

Returns

Read-only allocation InvokeId

Definition at line 277 of file Flow.cc.

Referenced by dup(), NFlowTable::findEntryByInvokeId(), NFlowTableEntry::info(), FA::receiveCreateFlowRequestFromRibd(), FANotifier::sendCreateRequestFlow(), FANotifier::sendCreateResponseNegative(), FANotifier::sendCreateResponsePostive(), and AP::startRequestedConnections().

const ConnectionId & Flow::getConId

(

)

const

Gets read-only Flow's ConnectionId.

Returns

Read-only ConnectionId instance

Definition at line 86 of file Flow.cc.

Referenced by RA::bindNFlowToNM1Flow(), EFCP::createEFCPI(), RA::createNM1Flow(), RA::createNM1FlowWithoutAllocate(), dup(), AEConstantClient::finish(), AESender::finish(), AESInt::finish(), EFCPTable::getEntryByFlow(), AEConstantClient::handleMessage(), AEConstantServer::handleMessage(), AEConstantClient::handleSelfMessage(), AEConstantServer::handleSelfMessage(), RA::postNFlowAllocation(), FA::receiveCreateFlowRequestFromRibd(), FAI::receiveCreateResponsePositive(), LisFACreFloPosi::receiveSignal(), LisRACreResPosi::receiveSignal(), LisFAICreResPosi::receiveSignal(), LisRADelFlow::receiveSignal(), LisFAICreResNega::receiveSignal(), LisFAICreResPosiNminusOne::receiveSignal(), RMTPort::setFlow(), and DTP::setPDUHeader().

ConnectionId & Flow::getConnectionId

(

)

Gets Flow's ConnectionId.

Returns

ConnectionId instance

Definition at line 209 of file Flow.cc.

Referenced by IDPerNFlow::generateIDFromFlow(), FA::receiveAllocateRequest(), FA::receiveCreateFlowRequestFromRibd(), FAI::receiveCreateResponsePositive(), ScoreComparer::run(), and MinComparer::run().

uint32_t Flow::getCreateFlowRetries

(

)

const

Gets current number of CreateFlow retries During Flow allocation phase, CreateFlow is incremented each time M_CREATE(flow) is sent.

Returns

Unsigned number of CreateFlow retry occurences

Definition at line 94 of file Flow.cc.

Referenced by dup(), AllocateRetryBase::run(), and LimitedRetries::run().

long Flow::getDeallocInvokeId

(

)

const

Gets deallocation InvokeId Used inside M_DELETE(_R)(flow) messages.

Returns

Read-only allocation InvokeId

Definition at line 285 of file Flow.cc.

Referenced by dup(), NFlowTableEntry::info(), FAI::receiveDeleteRequest(), FANotifier::sendDeleteRequestFlow(), and FANotifier::sendDeleteResponseFlow().

const Address & Flow::getDstAddr

(

)

const

Gets source Address, which is the address of communication end-point.

Returns

Read-only destination Address instance

Definition at line 150 of file Flow.cc.

Referenced by RA::bindNFlowToNM1Flow(), dup(), NFlowTable::findEntryByDstAddressAndFwd(), NFlowTable::findMgmtEntryByDstAddr(), Enrollment::insertStateTableEntry(), isManagementFlowLocalToIPCP(), FA::receiveMgmtAllocateRequest(), FANotifier::sendCreateResponseNegative(), FANotifier::sendCreateResponsePostive(), FANotifier::sendDeleteRequestFlow(), FANotifier::sendDeleteResponseFlow(), and DTP::setPDUHeader().

const APNamingInfo & Flow::getDstApni

(

)

const

Gets read-only destination APNamingInfo.

Returns

Read-only APNamingInfo instance

Definition at line 102 of file Flow.cc.

Referenced by RA::bindNFlowToNM1Flow(), FA::changeDstAddresses(), DAFEnrollment::createMgmtAE(), RA::createNM1Flow(), RA::createNM1FlowWithoutAllocate(), dup(), NFlowTable::findEntryByApns(), NFlowTable::findMgmtEntryByDstApni(), CACEGeneric::insertStateTableEntry(), CACEMgmt::insertStateTableEntry(), Enrollment::insertStateTableEntry(), FA::isMalformedFlow(), isManagementFlowLocalToIPCP(), IRM::newFlow(), RA::postNM1FlowAllocation(), FA::receiveAllocateRequest(), AP::receiveAllocationRequestFromFAI(), DAFEnrollment::receiveAllocationResponsePositive(), FA::receiveCreateFlowRequestFromRibd(), FA::receiveMgmtAllocateRequest(), LisDAFEnrollmentNotifierRcvEnrollCACE::receiveSignal(), LisDAFEnrollmentNotifierStaEnrolReq::receiveSignal(), LisDAFEnrollmentAllResPosi::receiveSignal(), LisDAFEnrollmentNotifierStaEnrolRes::receiveSignal(), LisDAFEnrollmentNotifierStoEnrolReq::receiveSignal(), LisDAFEnrollmentAllReqFromFai::receiveSignal(), LisFACreFloPosi::receiveSignal(), LisDAFEnrollmentNotifierStoEnrolRes::receiveSignal(), LisDAFEnrollmentNotifierStaOperReq::receiveSignal(), LisRACreResPosi::receiveSignal(), LisDAFEnrollmentNotifierStaOperRes::receiveSignal(), LisRADelFlow::receiveSignal(), RMTPort::setFlow(), FA::setNeighborAddresses(), FA::setOriginalAddresses(), DTP::setPDUHeader(), RA::sleepFlow(), CACEGeneric::startCACE(), CACEMgmt::startCACE(), and AP::startRequestedConnections().

const Address & Flow::getDstNeighbor

(

)

const

Gets neighbor destination Address, which is the address of (interim) hop-by-hop destination Used during flow allocation to pass the M_CREATE(_R)(flow) messages.

Returns

Read-only destination Address instance

Definition at line 340 of file Flow.cc.

Referenced by RA::bindNFlowToNM1Flow(), dup(), dupToMgmt(), NFlowTable::findEntriesAffectedByMgmt(), NFlowTable::findEntriesByDstNeighborAndFwd(), NFlowTable::findMgmtEntryByDstNeighbor(), RA::postNFlowAllocation(), FA::receiveAllocateRequest(), and FANotifier::sendCreateRequestFlow().

int Flow::getDstPortId

(

)

const

Gets destination PortId.

Returns

Read-only PortId number

Definition at line 110 of file Flow.cc.

Referenced by dup(), FA::receiveCreateFlowRequestFromRibd(), and FAI::receiveCreateResponsePositive().

std::string Flow::getFlowName

(

)

const

Prints flow name consisting of source and destination APNI Primary use is for OMNeT++ cMessage property to easily recognize which message is which.

Returns

String with concatenated source and destination

Definition at line 203 of file Flow.cc.

Referenced by FANotifier::sendCreateRequestFlow(), FANotifier::sendCreateResponseNegative(), FANotifier::sendCreateResponsePostive(), FANotifier::sendDeleteRequestFlow(), and FANotifier::sendDeleteResponseFlow().

uint32_t Flow::getHopCount

(

)

const

Gets hop-count, which is number of allowed message forwards from this device towards destination By default its initial value is 16 (const VAL_MAXHOPCOUNT).

Returns

Unsigned number representing current hop-count

Definition at line 118 of file Flow.cc.

Referenced by dup(), and FA::receiveCreateFlowRequestFromRibd().

uint32_t Flow::getMaxCreateFlowRetries

(

)

const

Gets maximum allowed number CreateFlow retries By default 3 (const VAL_MAXCREATERETRIES). Value is checked during Flow allocation.

Returns

Unsigned number of CreateFlow retry occurrences

Definition at line 126 of file Flow.cc.

Referenced by dup(), and LimitedRetries::run().

const QoSCube & Flow::getQosCube

(

)

const

Definition at line 171 of file Flow.cc.

Referenced by RA::createNM1Flow(), RA::createNM1FlowWithoutAllocate(), dup(), and FWQ::WeightedFairQMonitor::postQueueCreation().

QoSReq & Flow::getQosReqs

(

)

Definition at line 301 of file Flow.cc.

Referenced by RA::sleepFlow().

const QoSReq & Flow::getQosRequirements

(

)

const

Gets QoS parameters wanted by flow initiator.

Returns

Read-only QoSReq instance

Definition at line 176 of file Flow.cc.

Referenced by RA::bindNFlowToNM1Flow(), dup(), isManagementFlow(), AE::receiveAllocationRequestFromFAI(), DAFEnrollment::receiveAllocationRequestFromFAI(), LisDAFEnrollmentAllResPosi::receiveSignal(), LisDAFEnrollmentAllReqFromFai::receiveSignal(), MinComparer::run(), and ScoreComparer::run().

const Address & Flow::getSrcAddr

(

)

const

Gets source Address, which is the address of communication start-point.

Returns

Read-only source Address instance

Definition at line 158 of file Flow.cc.

Referenced by dup(), dupToMgmt(), NFlowTable::findEntriesAffectedByMgmt(), NFlowTable::findEntryBySrcAddressAndFwd(), IDPerNFlow::generateIDFromFlow(), isManagementFlowLocalToIPCP(), FA::receiveAllocateRequest(), FA::receiveCreateFlowRequestFromRibd(), and DTP::setPDUHeader().

const APNamingInfo & Flow::getSrcApni

(

)

const

Gets read-only source APNamingInfo.

Returns

Read-only APNamingInfo instance

Definition at line 134 of file Flow.cc.

Referenced by FA::changeSrcAddress(), ConnectionTableEntry::ConnectionTableEntry(), dup(), NFlowTable::findEntryByApns(), ConnectionTable::findEntryByFlow(), ConnectionTable::getFa(), ConnectionTable::getStatus(), CACEGeneric::insertStateTableEntry(), CACEMgmt::insertStateTableEntry(), Enrollment::insertStateTableEntry(), isManagementFlowLocalToIPCP(), RA::postNM1FlowAllocation(), DAFEnrollment::receiveAllocationResponsePositive(), FA::receiveCreateFlowRequestFromRibd(), FA::receiveMgmtAllocateRequest(), LisDAFEnrollmentNotifierRcvCACE::receiveSignal(), LisAPAllReqFromFai::receiveSignal(), LisAEAllReqFromFai::receiveSignal(), LisDAFEnrollmentAllResPosi::receiveSignal(), LisRIBDAllReqFromFai::receiveSignal(), LisAEDeallReqFromFai::receiveSignal(), LisDAFEnrollmentAllReqFromFai::receiveSignal(), LisFACreFloPosi::receiveSignal(), LisFAICreResPosiNminusOne::receiveSignal(), LisFAICreResNegaNminusOne::receiveSignal(), ScoreComparer::run(), MinComparer::run(), ConnectionTable::setFa(), FA::setNeighborAddresses(), ConnectionTable::setNorthGates(), FA::setOriginalAddresses(), DTP::setPDUHeader(), ConnectionTable::setSouthGates(), ConnectionTable::setStatus(), FAI::signalizeAllocationRequestFromFai(), RA::sleepFlow(), and CACEGeneric::startCACE().

const Address & Flow::getSrcNeighbor

(

)

const

Gets neighbor source Address, which is the address of (interim) hop-by-hop source Used during flow allocation to pass the M_CREATE(_R)(flow) messages.

Returns

Read-only source Address instance

Definition at line 348 of file Flow.cc.

Referenced by dup(), FA::receiveAllocateRequest(), FANotifier::sendCreateRequestFlow(), FANotifier::sendCreateResponseNegative(), FANotifier::sendCreateResponsePostive(), FANotifier::sendDeleteRequestFlow(), and FANotifier::sendDeleteResponseFlow().

int Flow::getSrcPortId

(

)

const

Gets source PortId.

Returns

Read-only PortId number

Definition at line 142 of file Flow.cc.

Referenced by RA::bindNM1FlowToRMT(), IRM::createBindings(), IRM::deleteBindings(), dup(), LisFAICreResPosi::receiveSignal(), and LisFAICreResNega::receiveSignal().

std::string Flow::info

(

)

const

Prints Flow information as string Calls variety of other info functions to produce final output.

Returns

String of Flow textual representation

Definition at line 327 of file Flow.cc.

Referenced by NM1FlowTableItem::info(), and operator<<().

std::string Flow::infoDestination

(

)

const

Prints Flow destination information as string Outputs destination APNI, address, neigbor-address, PortId, CEP-Id.

Returns

String representing Flow destination

Definition at line 239 of file Flow.cc.

Referenced by NFlowTableEntry::info(), and info().

std::string Flow::infoOther

(

)

const

Prints Flow create flow information and hop-cpunt as string.

Returns

String containing CreateFlow retries, MaxFlowRetries and hop-count numbers

Definition at line 249 of file Flow.cc.

Referenced by NFlowTableEntry::info(), and info().

std::string Flow::infoQoS

(

)

const

Prints RA's QoSCube-id that FA choosed during Flow allocation phase Accompanied QoSParameters could be find in AE that starts communication. They are omitted in order to make debug outputs more readable.

Returns

String of RA's QoSCube-id

Definition at line 258 of file Flow.cc.

Referenced by NFlowTableEntry::info(), and info().

std::string Flow::infoSource

(

)

const

Prints Flow source information as string Outputs source APNI, address, neigbor-address, PortId, CEP-Id.

Returns

String representing Flow source

Definition at line 229 of file Flow.cc.

Referenced by NFlowTableEntry::info(), and info().

bool Flow::isDdtFlag

(

)

const

Gets whether flow is for Degenerate Data Transfer.

Returns

True if DDT otherwise false

Definition at line 293 of file Flow.cc.

Referenced by FA::receiveAllocateRequest(), LisRAAllocResPos::receiveSignal(), and LisRACreAllocResPos::receiveSignal().

bool Flow::isManagementFlow

(

)

const

Definition at line 366 of file Flow.cc.

Referenced by RMTModuleAllocator::addPort(), RA::handleMessage(), infoQoS(), isManagementFlowLocalToIPCP(), RA::postNM1FlowAllocation(), LisEnrollmentGetFlowFromFaiCreResPosi::receiveSignal(), LisDAFEnrollmentGetFlowFromFaiCreResPosi::receiveSignal(), LisFAICreResPosiNminusOne::receiveSignal(), MinComparer::run(), and ScoreComparer::run().

bool Flow::isManagementFlowLocalToIPCP

(

)

const

Definition at line 370 of file Flow.cc.

Referenced by FAI::createBindings(), FAI::createNorthGates(), FAI::deleteBindings(), NFlowTable::findMgmtEntry(), NFlowTable::findMgmtEntryByDstAddr(), NFlowTable::findMgmtEntryByDstApni(), NFlowTable::findMgmtEntryByDstNeighbor(), infoDestination(), infoQoS(), infoSource(), FANotifier::receiveAllocationRequestFromFai(), LisFACreFloPosi::receiveSignal(), and FA::setNeighborAddresses().

bool Flow::operator==

(

const Flow &

other

)

const

Equal operator overloading.

Parameters

other

Flow for comparison

Returns

True if all atributes from this and other flow are equal

Definition at line 73 of file Flow.cc.

void Flow::setAllocInvokeId

(

long

allocInvokeId

)

Sets allocation InvokeId.

Parameters

allocInvokeId

A new allocation InvokeId

Definition at line 281 of file Flow.cc.

Referenced by AP::a_open(), dup(), and FANotifier::sendCreateRequestFlow().

void Flow::setConId

(

const ConnectionId &

conId

)

Sets Flow's ConnectionId.

Parameters

conId

A new ConnectionId instance

Definition at line 90 of file Flow.cc.

Referenced by dup().

void Flow::setCreateFlowRetries

(

uint32_t

createFlowRetries

)

Sets current number of CreateFlow retries During Flow allocation phase, CreateFlow is incremented each time M_CREATE(flow) is sent.

Definition at line 98 of file Flow.cc.

Referenced by dup(), AllocateRetryBase::run(), and LimitedRetries::run().

void Flow::setDdtFlag

(

bool

ddtFlag

)

Sets Degenerate Data Transfer flag.

Parameters

ddtFlag

True if DDT otherwise false

Definition at line 297 of file Flow.cc.

Referenced by FA::receiveAllocateRequest(), and FA::receiveCreateFlowRequestFromRibd().

void Flow::setDeallocInvokeId

(

long

deallocInvokeId

)

Sets deallocation InvokeId.

Parameters

deallocInvokeId

A new deallocation InvokeId

Definition at line 289 of file Flow.cc.

Referenced by dup(), FAI::receiveDeleteRequest(), and FANotifier::sendDeleteRequestFlow().

void Flow::setDstAddr

(

const Address &

dstAddr

)

Sets (end-point) destination Address.

Parameters

dstAddr

A new destination Address instance

Definition at line 154 of file Flow.cc.

Referenced by FA::changeDstAddresses(), dup(), dupToMgmt(), FA::receiveMgmtAllocateRequest(), and FA::setOriginalAddresses().

void Flow::setDstApni

(

const APNamingInfo &

dstApni

)

Sets destination APNamingInfo.

Parameters

dstApni

A new destination APNI instance

Definition at line 106 of file Flow.cc.

Referenced by dup(), and dupToMgmt().

void Flow::setDstNeighbor

(

const Address &

dstNeighbor

)

Sets neighbor destination Address.

Parameters

dstNeighbor

A new neighbor destination Address instance

Definition at line 344 of file Flow.cc.

Referenced by dup(), FA::receiveMgmtAllocateRequest(), and FA::setNeighborAddresses().

void Flow::setDstPortId

(

int

dstPortId

)

Sets destination PortId.

Parameters

srcPortId

A new PortId number

Definition at line 114 of file Flow.cc.

Referenced by dup(), and FAI::receiveCreateResponsePositive().

void Flow::setHopCount

(

uint32_t

hopCount

)

Sets a new hop-count. Hop-count should be decremented each time message is forwarded within DIF.

Parameters

hopCount

Unsigned number representing new hop-count

Definition at line 122 of file Flow.cc.

Referenced by dup(), and FA::receiveCreateFlowRequestFromRibd().

void Flow::setMaxCreateFlowRetries

(

uint32_t

maxCreateFlowRetries

)

Sets maximum allowed number of CreateFlow retries.

Parameters

maxCreateFlowRetries

Unsigned number specifying upper border

Definition at line 130 of file Flow.cc.

Referenced by dup().

void Flow::setQosCube

(

const QoSCube &

qosCube

)

Definition at line 167 of file Flow.cc.

Referenced by dup(), MinComparer::run(), and ScoreComparer::run().

void Flow::setQosRequirements

(

const QoSReq &

qosReqs

)

Sets QoS parameters wanted by flow initiator.

Parameters

qosParameters

A new QoSReq instance that is accompanied with Flow

Definition at line 323 of file Flow.cc.

Referenced by AEMyPing::afterOnStart(), AEPing::afterOnStart(), AEStream::afterOnStart(), RA::bindNFlowToNM1Flow(), dup(), dupToMgmt(), AEExtendedPing::handleSelfMessage(), AEConstantClient::handleSelfMessage(), AESender::handleSelfMessage(), AESInt::handleSelfMessage(), RA::initFlowAlloc(), FA::receiveMgmtAllocateRequest(), QoSMinComparer::setRequirements(), QoSIdComparer::setRequirements(), RA::sleepFlow(), and AE::start().

void Flow::setSrcAddr

(

const Address &

srcAddr

)

Sets (start-point) source Address.

Parameters

srcAddr

A new source Address instance

Definition at line 162 of file Flow.cc.

Referenced by FA::changeSrcAddress(), dup(), FA::receiveMgmtAllocateRequest(), and FA::setOriginalAddresses().

void Flow::setSrcApni

(

const APNamingInfo &

srcApni

)

Sets source APNamingInfo.

Parameters

srcApni

A new source APNI instance

Definition at line 138 of file Flow.cc.

Referenced by dup(), and dupToMgmt().

void Flow::setSrcNeighbor

(

const Address &

srcNeighbor

)

Sets neighbor source Address.

Parameters

srcNeighbor

A new neighbor source Address instance

Definition at line 352 of file Flow.cc.

Referenced by dup(), FA::receiveAllocateRequest(), FA::receiveCreateFlowRequestFromRibd(), FA::receiveMgmtAllocateRequest(), and FA::setNeighborAddresses().

void Flow::setSrcPortId

(

int

srcPortId

)

Sets source PortId.

Parameters

srcPortId

A new PortId number

Definition at line 146 of file Flow.cc.

Referenced by dup(), FA::receiveAllocateRequest(), and FA::receiveCreateFlowRequestFromRibd().

void Flow::swapAddresses ( )

protected

Auxiliary function swapping source and destination Addresses.

Definition at line 219 of file Flow.cc.

Referenced by swapFlow().

void Flow::swapApni ( )

protected

Auxiliary function swapping source and destinatio APNI.

Definition at line 305 of file Flow.cc.

Referenced by swapFlow().

void Flow::swapCepIds ( )

protected

Auxiliary function swapping source and destination CEP-Ids.

Definition at line 225 of file Flow.cc.

Referenced by swapFlow().

Flow & Flow::swapFlow

(

)

Function that swaps relevant source and destination Flow parameters It is being used mainly for counterpart communication during Flow (de)allocation.

Returns

Returns same flow but with swapped properties

Definition at line 311 of file Flow.cc.

Referenced by QueuePerNFlow::onNFlowAlloc(), FANotifier::processMCreate(), FANotifier::processMCreateR(), FANotifier::processMDelete(), FANotifier::processMDeleteR(), and FA::receiveCreateFlowRequestFromRibd().

void Flow::swapPortIds ( )

protected

Auxiliary function swapping source and destination PortIds.

Definition at line 213 of file Flow.cc.

Referenced by swapFlow().

Member Data Documentation

long Flow::allocInvokeId

protected

Attribute holding persistant InvokeId used for allocation.

Definition at line 431 of file Flow.h.

Referenced by getAllocInvokeId(), setAllocInvokeId(), and ~Flow().

ConnectionId Flow::conId

protected

Attribute holding ConnectionId containing source and destination CEP-Ids and chosen RA's QoSCube.

Definition at line 400 of file Flow.h.

Referenced by compare(), getConId(), getConnectionId(), infoDestination(), infoQoS(), infoSource(), operator==(), setConId(), and swapCepIds().

uint32_t Flow::createFlowRetries

protected

Attribute holding current number of allowed CreateFlow retries.

Definition at line 405 of file Flow.h.

Referenced by getCreateFlowRetries(), infoOther(), operator==(), setCreateFlowRetries(), and ~Flow().

bool Flow::ddtFlag

protected

Attribute representing whether flow is for Degenerate Data Transfer or not.

Definition at line 441 of file Flow.h.

Referenced by infoOther(), isDdtFlag(), operator==(), setDdtFlag(), and ~Flow().

long Flow::deallocInvokeId

protected

Attribute holding persistant InvokeId used for deallocation.

Definition at line 436 of file Flow.h.

Referenced by getDeallocInvokeId(), setDeallocInvokeId(), and ~Flow().

Address Flow::dstAddr

protected

Attribute holding destination address (end-host for communication)

Definition at line 385 of file Flow.h.

Referenced by compare(), getDstAddr(), infoDestination(), operator==(), setDstAddr(), swapAddresses(), and ~Flow().

APNamingInfo Flow::dstApni

protected

Attribute holding destination APNI.

Definition at line 365 of file Flow.h.

Referenced by compare(), getDstApni(), getFlowName(), infoDestination(), operator==(), setDstApni(), swapApni(), and ~Flow().

Address Flow::dstNeighbor

protected

Attribute holding hop-by-hop destination address.

Definition at line 395 of file Flow.h.

Referenced by getDstNeighbor(), infoDestination(), operator==(), setDstNeighbor(), and ~Flow().

int Flow::dstPortId

protected

Attribute holding destination PortId.

Definition at line 375 of file Flow.h.

Referenced by compare(), getDstPortId(), infoDestination(), operator==(), setDstPortId(), swapPortIds(), and ~Flow().

uint32_t Flow::hopCount

protected

Attribute holding flow's hop-count.

Definition at line 415 of file Flow.h.

Referenced by getHopCount(), infoOther(), operator==(), setHopCount(), and ~Flow().

uint32_t Flow::maxCreateFlowRetries

protected

Attribute holding maximum allowed number of CreateFlow retries.

Definition at line 410 of file Flow.h.

Referenced by getMaxCreateFlowRetries(), infoOther(), operator==(), setMaxCreateFlowRetries(), and ~Flow().

QoSCube Flow::qosCube

protected

Attribute holding the assigned QoSCube.

Definition at line 421 of file Flow.h.

Referenced by getQosCube(), and setQosCube().

QoSReq Flow::qosReqs

protected

Attribute holding wanted QoS parameters in form of QoSReq.

Definition at line 426 of file Flow.h.

Referenced by getQosReqs(), getQosRequirements(), infoQoS(), and setQosRequirements().

Address Flow::srcAddr

protected

Attribute holding source address (initiator of communication)

Definition at line 380 of file Flow.h.

Referenced by compare(), getSrcAddr(), infoSource(), operator==(), setSrcAddr(), swapAddresses(), and ~Flow().

APNamingInfo Flow::srcApni

protected

Attribute holding source APNI.

Definition at line 360 of file Flow.h.

Referenced by compare(), getFlowName(), getSrcApni(), infoSource(), operator==(), setSrcApni(), swapApni(), and ~Flow().

Address Flow::srcNeighbor

protected

Attribute holding hop-by-hop source address.

Definition at line 390 of file Flow.h.

Referenced by getSrcNeighbor(), infoSource(), operator==(), setSrcNeighbor(), and ~Flow().

int Flow::srcPortId

protected

Attribute holding source PortId.

Definition at line 370 of file Flow.h.

Referenced by compare(), getSrcPortId(), infoSource(), operator==(), setSrcPortId(), swapPortIds(), and ~Flow().

---

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

• src/Common/Flow.h
• src/Common/Flow.cc