User Manual, Developers Guide and API Documentation

tcp::LowerConvergence Class Reference

#include <LowerConvergence.hpp>

Inheritance diagram for tcp::LowerConvergence:

Inheritance graph
[legend]
Collaboration diagram for tcp::LowerConvergence:

Collaboration graph
[legend]

List of all members.

Public Types

typedef
wns::container::Registry
< wns::service::tl::FlowID,
wns::service::dll::FlowID
FlowIDMapping

Public Member Functions

virtual void doOnData (const wns::ldk::CompoundPtr &compound)
virtual void doSendData (const wns::ldk::CompoundPtr &compound)
 LowerConvergence (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &_config)
void mapFlowID (wns::service::tl::FlowID flowID, wns::service::dll::FlowID dllFlowID)
virtual void onFUNCreated ()
 Resolve inter-FU dependencies.
virtual void setDataTransmissionService (wns::service::nl::Service *service)
void setProtocolNumber (wns::service::nl::protocolNumber _protocolNumber)
 Set the protocol number ID. This is needed to use the IP data transmission service.
void setTLService (Service *_tlService)
 The service of the transport layer (either UDP or TCP).
void unmapFlowID (wns::service::tl::FlowID flowID)
virtual ~LowerConvergence ()

Private Member Functions

virtual bool doIsAccepting (const wns::ldk::CompoundPtr &compound) const
virtual void doWakeup ()
wns::service::nl::ServicegetDataTransmissionService () const
 Return the data transmission service provided by the layer below.

Private Attributes

wns::pyconfig::View config
wns::service::nl::ServicedataTransmissionService
 The data transmission service provided by the IP layer.
FlowIDMapping flowIDMapper
struct
tcp::LowerConvergence::Friends 
friends
wns::logger::Logger logger
wns::service::nl::protocolNumber protocolNumber
 For differentiation of different transport layer protocols. The transport layer protocols register at the IP data transmission service with a protocol ID.
wns::ldk::CommandReaderInterfacetcpHeaderReader
ServicetlService

Classes

struct  Friends


Detailed Description

Definition at line 45 of file LowerConvergence.hpp.


Member Typedef Documentation

Definition at line 54 of file LowerConvergence.hpp.


Constructor & Destructor Documentation

tcp::LowerConvergence::LowerConvergence ( wns::ldk::fun::FUN fun,
const wns::pyconfig::View _config 
)

virtual tcp::LowerConvergence::~LowerConvergence (  )  [virtual]


Member Function Documentation

virtual bool tcp::LowerConvergence::doIsAccepting ( const wns::ldk::CompoundPtr compound  )  const [private, virtual]

virtual void tcp::LowerConvergence::doOnData ( const wns::ldk::CompoundPtr compound  )  [virtual]

virtual void tcp::LowerConvergence::doSendData ( const wns::ldk::CompoundPtr compound  )  [virtual]

virtual void tcp::LowerConvergence::doWakeup (  )  [private, virtual]

wns::service::nl::Service* tcp::LowerConvergence::getDataTransmissionService (  )  const [private]

void tcp::LowerConvergence::mapFlowID ( wns::service::tl::FlowID  flowID,
wns::service::dll::FlowID  dllFlowID 
)

virtual void tcp::LowerConvergence::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.

virtual void tcp::LowerConvergence::setDataTransmissionService ( wns::service::nl::Service service  )  [virtual]

void tcp::LowerConvergence::setProtocolNumber ( wns::service::nl::protocolNumber  _protocolNumber  ) 

void tcp::LowerConvergence::setTLService ( Service _tlService  ) 

void tcp::LowerConvergence::unmapFlowID ( wns::service::tl::FlowID  flowID  ) 


Member Data Documentation

Definition at line 113 of file LowerConvergence.hpp.

Definition at line 111 of file LowerConvergence.hpp.

Definition at line 130 of file LowerConvergence.hpp.

Definition at line 117 of file LowerConvergence.hpp.

Definition at line 128 of file LowerConvergence.hpp.

Definition at line 132 of file LowerConvergence.hpp.

Definition at line 115 of file LowerConvergence.hpp.


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

Generated on Sat May 26 03:32:40 2012 for openWNS by  doxygen 1.5.5