X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=655e22540aec9121d1214f24b0dff67eebb9f84c;hb=81ffa1c459b96dd44472bcef37e1e373934ee138;hp=907d5a92fb433e50036eadd9073c95220e0f8616;hpb=a4887e674af3fce4180cf7e14bedace928962025;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 907d5a9..655e225 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -19,7 +19,7 @@ // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. /** \file - \brief Conenctors public header */ + \brief Connectors public header */ /** \defgroup connectors Connector classes @@ -37,17 +37,25 @@ senf::ppi::PassiveInput and senf::ppi::PassiveOutput. */ -#ifndef HH_Conenctors_ -#define HH_Conenctors_ 1 +#ifndef HH_Connectors_ +#define HH_Connectors_ 1 // Custom includes +#include #include - -//#include "Conenctors.mpp" +#include +#include "Utils/SafeBool.hh" +#include "Packets/Packets.hh" +#include "predecl.hh" +#include "detail/Callback.hh" +#include "Queueing.hh" + +//#include "Connectors.mpp" ///////////////////////////////hh.p//////////////////////////////////////// namespace senf { namespace ppi { +namespace connector { /** \brief Connector baseclass @@ -60,12 +68,21 @@ namespace ppi { { public: Connector & peer(); ///< Get peer connected to this connector - Module & module(); ///< Get this connectors containing module + module::Module & module(); ///< Get this connectors containing module protected: - // here to protect Connector(); - ~Connector(); + virtual ~Connector(); + + void connect(Connector & target); + + private: + void setModule(module::Module & module); + + Connector * peer_; + module::Module * module_; + + friend class module::Module; }; /** \brief Passive connector baseclass @@ -83,8 +100,6 @@ namespace ppi { notifications The accumulative throttling state is generated by combining all sub-states. - - \ingroup connectors */ class PassiveConnector : public virtual Connector @@ -116,9 +131,14 @@ namespace ppi { ActiveConnector & peer(); protected: - // here to protect PassiveConnector(); - ~PassiveConnector(); + + void emit(); + + private: + + typedef detail::Callback<>::type Callback; + Callback callback_; }; /** \brief Active connector baseclass @@ -130,15 +150,13 @@ namespace ppi { Active connectors do not handle any throttling state, they just receive the notifications. These notifications should then either be processed by the module or be forwarded to other connectors. - - \ingroup connectors */ class ActiveConnector : public virtual Connector { public: template - void onThrottle(Handler); ///< Register throttle notification handler + void onThrottle(Handler handle); ///< Register throttle notification handler /**< The handler register here will be called, whenever a throttle notification comes in. The \a handler argument is either an arbitrary callable object or it is a @@ -146,11 +164,11 @@ namespace ppi { this input. In the second case, the pointer will automatically be bound to the containing instance. - \param[in] handler Handler to call on throttle + \param[in] handle Handler to call on throttle notifications. */ template - void onUnthrottle(Handler); ///< Register unthrottle notification handler + void onUnthrottle(Handler handle); ///< Register unthrottle notification handler /**< The handler register here will be called, whenever an unthrottle notification comes in. The \a handler argument is either an arbitrary callable object or it @@ -158,15 +176,13 @@ namespace ppi { holds this input. In the second case, the pointer will automatically be bound to the containing instance. - \param[in] handler Handler to call on unthrottle + \param[in] handle Handler to call on unthrottle notifications. */ PassiveConnector & peer(); protected: - // here to protect - PassiveConnector(); - ~PassiveConnector(); + ActiveConnector(); }; /** \brief Input connector baseclass @@ -176,16 +192,29 @@ namespace ppi { packets in batches or generating multiple output packets from a single input packet. The queues have the potential to greatly simplify the module implementations. - \ingroup connectors + \implementation Which container to use? + \li list has good insertion and deletion properties on both ends but it costs a dynamic + memory allocation for every insertion. A very good property is, that iterators stay + valid across insertions/deletions + \li vector is fast and has good amortized dynamic allocation properties. However, it is + quite unusable as a queue + \li deque has comparable dynamic allocation properties as vector but also has good + insertion/removal properties on both ends. + + So probably we will use a deque. I'd like a container which keeps iterators intact on + isertion/deletion but I believe that list is just to expensive since every packet will + be added to the queue before it can be processed. */ class InputConnector - : public virtual Connector + : public virtual Connector, + public SafeBool { + typedef std::deque Queue; public: - typedef unspecified queue_iterator; ///< Iterator type of the embedded queue - typedef unspecified size_type; ///< Unsigned type representing the number of queue elements + typedef Queue::const_iterator queue_iterator; ///< Iterator type of the embedded queue + typedef Queue::size_type size_type; ///< Unsigned type for counting queue elements - Packet::ptr operator(); ///< Get a packet + Packet operator()(); ///< Get a packet /**< This member is the primary method to access received data. On passive connectors, this operator will just dequeue a packet from the packet queue. If the @@ -194,9 +223,9 @@ namespace ppi { request cannot be fulfilled, this is considered to be a logic error in the module implementation and an exception is raised. */ - operator unspecified_boolean_type (); ///< Check packet availability + bool boolean_test (); ///< Check packet availability /**< Using any input connector in a boolean context will - check, wether an input request can be fulfilled. This + check, whether an input request can be fulfilled. This is always possible if the queue is non-empty. If the input is active, it also returns when the connected passive output is not throttled so new packets can be @@ -207,24 +236,28 @@ namespace ppi { \returns \c true if operator() can be called, \c false otherwise */ - operator ! (); ///< Check packet availability - /**< Inverse of the boolean conversion operator - \returns \c false if operator() can be called, \c true - otherwise */ OutputConnector & peer(); queue_iterator begin(); ///< Access queue begin (head) queue_iterator end(); ///< Access queue past-the-end (tail) - Packet::ptr head(); ///< Return head element from the queue + Packet peek(); ///< Return head element from the queue size_type queueSize(); ///< Return number of elements in the queue bool empty(); ///< Return queueSize() == 0 protected: - // here to protect - PassiveConnector(); - ~PassiveConnector(); + InputConnector(); + + private: + void enqueue(Packet p); + + virtual void v_enqueueEvent(); + virtual void v_dequeueEvent(); + + Queue queue_; + + friend class OutputConnector; }; /** \brief Output connector baseclass @@ -232,78 +265,96 @@ namespace ppi { An output connector sends out packets. It may be either an ActiveConnector or a PassiveConnector. An output connector does \e not have an built-in queueing, it relies on the queueing of the connected input. - - \ingroup connectors */ class OutputConnector : public virtual Connector { public: - void operator(Packet::ptr); ///< Send out a packet + void operator()(Packet p); ///< Send out a packet InputConnector & peer(); protected: - // here to protect - PassiveConnector(); - ~PassiveConnector(); + OutputConnector(); }; + + ///@{ + ///\addtogroup connectors /** \brief Combination of PassiveConnector and InputConnector - \ingroup connectors + In addition to the native and the forwarded throttling state, the PassiveInput manages a + queue throttling state. This state is automatically managed by a queueing discipline. The + standard queueing discipline is ThresholdQueueing, which throttles the connection whenever + the queue length reaches the high threshold and unthrottles the connection when the queue + reaches the low threshold. The default queueing discipline is + ThresholdQueueing(1,0) which will throttle the input whenever the queue is + non-empty. */ class PassiveInput : public PassiveConnector, public InputConnector { public: + PassiveInput(); + ActiveOutput & peer(); template - QDisc const & qdisc(QDisc const & disc); + void qdisc(QDisc const & disc); ///< Change the queueing discipline + /**< The queueing discipline is a class which provides the + QueueingDiscipline interface. + + \param[in] disc New queueing discipline */ + + private: + void v_enqueueEvent(); + void v_dequeueEvent(); + + boost::scoped_ptr qdisc_; + QueueingDiscipline::State qstate_; }; /** \brief Combination of PassiveConnector and OutputConnector - - \ingroup connectors */ class PassiveOutput : public PassiveConnector, public OutputConnector { public: ActiveInput & peer(); + + void connect(ActiveInput & target); }; /** \brief Combination of ActiveConnector and InputConnector - - \ingroup connectors */ class ActiveInput : public ActiveConnector, public InputConnector { public: - void request(); ///< request more packets without dequeing any packet - PassiveOutput & peer(); + + void request(); ///< request more packets without dequeuing any packet }; /** \brief Combination of ActiveConnector and OutputConnector - - \ingroup connectors */ class ActiveOutput : public ActiveConnector, public OutputConnector { public: ActiveInput & peer(); + + void connect(PassiveInput & target); }; -}} + ///@} + +}}} ///////////////////////////////hh.e//////////////////////////////////////// -//#include "Conenctors.cci" -//#include "Conenctors.ct" -//#include "Conenctors.cti" +#include "Connectors.cci" +//#include "Connectors.ct" +#include "Connectors.cti" #endif @@ -313,4 +364,6 @@ namespace ppi { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" +// compile-command: "scons -u test" +// comment-column: 40 // End: