User Manual, Developers Guide and API Documentation

wns::ldk::tools::Consumer Class Reference

The packet-eater. More...

#include <ldk/tools/Consumer.hpp>

Inheritance diagram for wns::ldk::tools::Consumer:

Inheritance graph
[legend]
Collaboration diagram for wns::ldk::tools::Consumer:

Collaboration graph
[legend]

List of all members.

Public Types

typedef std::list< CompoundPtrContainerType

Public Member Functions

void consumeIncoming (bool choice=true)
 Configure the Consumer whether to drop incoming packets.
void consumeOutgoing (bool choice=true)
 Configure the Consumer whether to drop outgoing packets.
 Consumer (fun::FUN *, const wns::pyconfig::View &)
 Consumer (fun::FUN *fuNet, bool _incoming=false, bool _outgoing=false)
virtual void doOnData (const CompoundPtr &compound)
virtual void doSendData (const CompoundPtr &compound)

Private Member Functions

virtual bool doIsAccepting (const CompoundPtr &compound) const
virtual void doWakeup ()

Private Attributes

bool incoming
bool outgoing


Detailed Description

Drops packets in uplink and/or downlink. Use this during testing at the bottom or top of a stack where you don't care about the actual compounds received/sent (IF you care, you should have a look at the Stub).

Definition at line 51 of file Consumer.hpp.


Member Typedef Documentation

Definition at line 60 of file Consumer.hpp.


Constructor & Destructor Documentation

wns::ldk::tools::Consumer::Consumer ( fun::FUN fuNet,
bool  _incoming = false,
bool  _outgoing = false 
) [inline]

Definition at line 62 of file Consumer.hpp.

Consumer::Consumer ( fun::FUN fuNet,
const wns::pyconfig::View config 
)

Definition at line 38 of file Consumer.cpp.


Member Function Documentation

void wns::ldk::tools::Consumer::consumeIncoming ( bool  choice = true  )  [inline]

Definition at line 80 of file Consumer.hpp.

void wns::ldk::tools::Consumer::consumeOutgoing ( bool  choice = true  )  [inline]

Definition at line 91 of file Consumer.hpp.

virtual bool wns::ldk::tools::Consumer::doIsAccepting ( const CompoundPtr compound  )  const [inline, private, virtual]

Definition at line 123 of file Consumer.hpp.

virtual void wns::ldk::tools::Consumer::doOnData ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 108 of file Consumer.hpp.

virtual void wns::ldk::tools::Consumer::doSendData ( const CompoundPtr compound  )  [inline, virtual]

Definition at line 97 of file Consumer.hpp.

virtual void wns::ldk::tools::Consumer::doWakeup (  )  [inline, private, virtual]

Definition at line 132 of file Consumer.hpp.


Member Data Documentation

Definition at line 137 of file Consumer.hpp.

Definition at line 138 of file Consumer.hpp.


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

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