wns::ldk::FlowGate Class Reference

#include <ldk/FlowGate.hpp>

Inheritance diagram for wns::ldk::FlowGate:

[legend]

Collaboration diagram for wns::ldk::FlowGate:

[legend]

List of all members.

Public Member Functions
	FlowGate (fun::FUN *fun, const wns::pyconfig::View &config, KeyBuilder *builder)
	Constructor for use by the unitTest.
	FlowGate (fun::FUN *fun, const wns::pyconfig::View &config)
	default FUN/Config Constructor
virtual void	onFUNCreated ()
	Resolve inter-FU dependencies.
virtual	~FlowGate ()
FlowGateInterface
Description
virtual void	closeFlow (const ConstKeyPtr &key)
virtual void	createFlow (const ConstKeyPtr &key)
virtual void	destroyFlow (const ConstKeyPtr &key)
virtual void	openFlow (const ConstKeyPtr &key)
CompoundHandlerInterface
The CompoundHandlerInterface methods (isAccepting, doSendData, doOnData, wakeup) are delegated to the matching instance. Instance retrieval is delegated to the internal implementation _getInstance. If no matching instance is found, new instances may get instantiated on the fly. In future this may depend on the FlowSeparator configuration.
virtual bool	doIsAccepting (const CompoundPtr &compound) const
virtual void	doOnData (const CompoundPtr &compound)
virtual void	doSendData (const CompoundPtr &compound)
virtual void	doWakeup ()
Private Types
typedef std::map< ConstKeyPtr, bool, DerefLess< ConstKeyPtr > >	FlowStatus
Private Member Functions
bool	flowIsKnown (const ConstKeyPtr &key) const
Private Attributes
FlowStatus	flowStatus
KeyBuilder *	keyBuilder
wns::logger::Logger	logger

---

Detailed Description

Definition at line 66 of file FlowGate.hpp.

---

Member Typedef Documentation

typedef std::map<ConstKeyPtr, bool, DerefLess<ConstKeyPtr> > wns::ldk::FlowGate::FlowStatus [private]

Definition at line 75 of file FlowGate.hpp.

---

Constructor & Destructor Documentation

FlowGate::FlowGate	(	fun::FUN *	fun,
		const wns::pyconfig::View &	config
	)

Definition at line 39 of file FlowGate.cpp.

FlowGate::FlowGate	(	fun::FUN *	fun,
		const wns::pyconfig::View &	config,
		KeyBuilder *	builder
	)

Definition at line 55 of file FlowGate.cpp.

FlowGate::~FlowGate

(

)

[virtual]

Definition at line 67 of file FlowGate.cpp.

---

Member Function Documentation

void FlowGate::closeFlow

(

const ConstKeyPtr &

key

)

[virtual]

Implements wns::ldk::FlowGateInterface.

Definition at line 179 of file FlowGate.cpp.

void FlowGate::createFlow

(

const ConstKeyPtr &

key

)

[virtual]

Implements wns::ldk::FlowGateInterface.

Definition at line 153 of file FlowGate.cpp.

void FlowGate::destroyFlow

(

const ConstKeyPtr &

key

)

[virtual]

Implements wns::ldk::FlowGateInterface.

Definition at line 161 of file FlowGate.cpp.

bool FlowGate::doIsAccepting

(

const CompoundPtr &

compound

)

const [virtual]

Definition at line 120 of file FlowGate.cpp.

void FlowGate::doOnData

(

const CompoundPtr &

compound

)

[virtual]

Definition at line 94 of file FlowGate.cpp.

void FlowGate::doSendData

(

const CompoundPtr &

compound

)

[virtual]

Definition at line 85 of file FlowGate.cpp.

void FlowGate::doWakeup

(

)

[virtual]

Definition at line 146 of file FlowGate.cpp.

bool FlowGate::flowIsKnown

(

const ConstKeyPtr &

key

)

const [private]

Definition at line 187 of file FlowGate.cpp.

void FlowGate::onFUNCreated

(

)

[virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

Definition at line 79 of file FlowGate.cpp.

void FlowGate::openFlow

(

const ConstKeyPtr &

key

)

[virtual]

Implements wns::ldk::FlowGateInterface.

Definition at line 171 of file FlowGate.cpp.

---

Member Data Documentation

FlowStatus wns::ldk::FlowGate::flowStatus [private]

Definition at line 76 of file FlowGate.hpp.

KeyBuilder* wns::ldk::FlowGate::keyBuilder [private]

Definition at line 78 of file FlowGate.hpp.

wns::logger::Logger wns::ldk::FlowGate::logger [private]

Definition at line 80 of file FlowGate.hpp.

---

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

• framework/library/src/ldk/FlowGate.hpp
• framework/library/src/ldk/FlowGate.cpp