X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=4779c3036681867519389053c241dcfb2c46f043;hb=ae06fe86f16fdabb7ffb219d255444d2eb4f4f79;hp=6e01ca36cfdbb1b6d78b247f4376f6186142c33b;hpb=f539f4271d470794a773a92bacd8ba086c9bc1cd;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 6e01ca3..4779c30 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -21,22 +21,6 @@ /** \file \brief Connectors public header */ -/** \defgroup connectors Connector classes - - A connector has two independent properties - \li it may be \e active or \e passive - \li it may be an \e input or an \e output - - \e Active connectors are activated from within the module, \e passive connectors are signaled by - the external framework. \e Input modules receive packets, \e output modules send packets. - - All passive connectors call some onRequest callback whenever I/O needs to be performed. All - input modules possess a packet queue. - - We therefore have 4 connector types: senf::ppi::ActiveInput, senf::ppi::ActiveOutput, - senf::ppi::PassiveInput and senf::ppi::PassiveOutput. - */ - #ifndef HH_Connectors_ #define HH_Connectors_ 1 @@ -44,8 +28,8 @@ #include #include #include -#include "Utils/SafeBool.hh" -#include "Packets/Packets.hh" +#include "../Utils/SafeBool.hh" +#include "../Packets/Packets.hh" #include "predecl.hh" #include "detail/Callback.hh" #include "Queueing.hh" @@ -57,7 +41,36 @@ namespace senf { namespace ppi { namespace connector { - /** \brief Connector baseclass + /** \namespace senf::ppi::connector + \brief Connector classes + + A connector has two independent properties + \li it may be \e active or \e passive + \li it may be an \e input or an \e output + + \e Active connectors are activated from within the module, \e passive connectors are + signaled by the external framework. \e Input modules receive packets, \e output modules send + packets. + + All passive connectors call some onRequest callback whenever I/O needs to be performed. All + input modules possess a packet queue. + + We therefore have 4 connector types: + \li senf::ppi::connector::ActiveInput + \li senf::ppi::connector::ActiveOutput + \li senf::ppi::connector::PassiveInput + \li senf::ppi::connector::PassiveOutput. + + Connectors are declared as module data members and are then externally connected to other + modules. + + \see + senf::ppi::module::Module \n + senf::ppi::connect() + \ref ppi_connectors + */ + + /** \brief Connector base-class This connector provides access to the generic connector facilities. This includes the connection management (access to the connected peer) and the containment management (access @@ -85,7 +98,7 @@ namespace connector { friend class module::Module; }; - /** \brief Passive connector baseclass + /** \brief Passive connector base-class A passive connector is a connector which is activated externally whenever an I/O request occurs. Passive connectors are the origin of throttling notifications. Depending on the type @@ -134,8 +147,8 @@ namespace connector { private: // Called by the routing to change the remote throttling state - void notifyThrottle(); ///< Forward a throttling notification to this connector - void notifyUnthrottle(); ///< Forward an unthrottling notification to this connector + void notifyThrottle(); ///< Forward a throttle notification to this connector + void notifyUnthrottle(); ///< Forward an unthrottle notification to this connector // Internal members to emit throttling notifications void emitThrottle(); @@ -144,17 +157,22 @@ namespace connector { // Called after unthrottling the connector virtual void v_unthrottleEvent(); + // called by ForwardingRoute to register a new route + void registerRoute(ForwardingRoute & route); + typedef detail::Callback<>::type Callback; Callback callback_; bool remoteThrottled_; bool nativeThrottled_; - friend class senf::ppi::detail::ForwardForwardingRouteImplementation; - friend class senf::ppi::detail::BackwardForwardingRouteImplementation; + typedef std::vector Routes; + Routes routes_; + + friend class senf::ppi::ForwardingRoute; }; - /** \brief Active connector baseclass + /** \brief Active connector base-class An active connector is a connector which emits I/O requests. Active connectors receive throttling notifications. Depending on the type of connector (input or output) the @@ -180,7 +198,7 @@ namespace connector { \param[in] handler Handler to call on throttle notifications. */ - void onThrottle(); + void onThrottle(); ///< Clear throttle notification handler template void onUnthrottle(Handler handler); ///< Register unthrottle notification handler @@ -191,9 +209,11 @@ namespace connector { holds this input. In the second case, the pointer will automatically be bound to the containing instance. - \param[in] handle Handler to call on unthrottle + \param[in] handler Handler to call on unthrottle notifications. */ - void onUnthrottle(); + void onUnthrottle(); ///< Clear unthrottle notification handler + + bool throttled() const; ///< \c true, if peer() is throttled PassiveConnector & peer() const; @@ -218,7 +238,7 @@ namespace connector { friend class PassiveConnector; }; - /** \brief Input connector baseclass + /** \brief Input connector base-class An input connector receives packets. It may be either an ActiveConnector or a PassiveConnector. An input connector contains a packet queue. This queue enables processing @@ -235,7 +255,7 @@ namespace connector { 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 + insertion/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 @@ -246,6 +266,7 @@ namespace connector { 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 operator()(); ///< Get a packet /**< This member is the primary method to access received data. On passive connectors, this operator will just @@ -256,6 +277,8 @@ namespace connector { logic error in the module implementation and an exception is raised. */ + Packet read(); ///< Alias for operator()() + OutputConnector & peer() const; queue_iterator begin() const; ///< Access queue begin (head) @@ -280,7 +303,7 @@ namespace connector { friend class OutputConnector; }; - /** \brief Output connector baseclass + /** \brief Output connector base-class 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 @@ -290,7 +313,9 @@ namespace connector { : public virtual Connector { public: - void operator()(Packet p); ///< Send out a packet + void operator()(Packet p); ///< Send out a packet + + void write(Packet p); ///< Alias for operator()(Packet p) InputConnector & peer() const; @@ -298,9 +323,6 @@ namespace connector { OutputConnector(); }; - ///@{ - ///\addtogroup connectors - /** \brief Combination of PassiveConnector and InputConnector The PassiveInput automatically controls the connectors throttling state using a queueing @@ -319,7 +341,7 @@ namespace connector { ActiveOutput & peer() const; - bool boolean_test() const; + bool boolean_test() const; ///< \c true, if ! empty() template void qdisc(QDisc const & disc); ///< Change the queueing discipline @@ -345,9 +367,9 @@ namespace connector { public: ActiveInput & peer() const; - bool boolean_test() const; + bool boolean_test() const; ///< Always \c true - void connect(ActiveInput & target); + void connect(ActiveInput & target); ///< Internal: Use senf::ppi::connect() instead friend class ActiveInput; }; @@ -361,7 +383,7 @@ namespace connector { public: PassiveOutput & peer() const; - bool boolean_test() const; + bool boolean_test() const; ///< \c true, if ! empty() or ! throttled() void request(); ///< request more packets without dequeuing any packet @@ -378,13 +400,11 @@ namespace connector { public: PassiveInput & peer() const; - bool boolean_test() const; + bool boolean_test() const; ///< \c true if peer() is ! throttled() - void connect(PassiveInput & target); + void connect(PassiveInput & target); ///< Internal: Use senf::ppi::connect() instead }; - ///@} - }}} ///////////////////////////////hh.e////////////////////////////////////////