X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=d82e14a8c41b981c51228602e7ac1967f02dcfea;hb=dab85c1701097d7f139f0fa9206cc13320b25889;hp=1b299e2337c2bd933663e885445007e6aabb2ef4;hpb=89efe5f504c400212090aba703c7ee385f483c64;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 1b299e2..d82e14a 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -48,9 +48,7 @@ namespace senf { namespace ppi { - - ///@{ - ///\addtogroup connectors +namespace connector { /** \brief Connector baseclass @@ -137,7 +135,7 @@ namespace ppi { { 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 @@ -145,11 +143,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 handler); ///< 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 @@ -157,7 +155,7 @@ 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(); @@ -206,7 +204,7 @@ namespace ppi { exception is raised. */ operator unspecified_boolean_type (); ///< 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 @@ -256,6 +254,9 @@ namespace ppi { PassiveConnector(); ~PassiveConnector(); }; + + ///@{ + ///\addtogroup connectors /** \brief Combination of PassiveConnector and InputConnector @@ -263,7 +264,7 @@ namespace ppi { 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 discpiline is + reaches the low threshold. The default queueing discipline is ThresholdQueueing(1,0) which will throttle the input whenever the queue is non-empty. */ @@ -298,7 +299,7 @@ namespace ppi { public: PassiveOutput & peer(); - void request(); ///< request more packets without dequeing any packet + void request(); ///< request more packets without dequeuing any packet }; /** \brief Combination of ActiveConnector and OutputConnector @@ -312,7 +313,7 @@ namespace ppi { ///@} -}} +}}} ///////////////////////////////hh.e//////////////////////////////////////// //#include "Conenctors.cci" @@ -327,4 +328,5 @@ namespace ppi { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" +// compile-command: "scons -u test" // End: