X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=c915c062a43dda96ce79a5f62a24029aabad97d4;hb=cb10487f67b404334eaffa60f074b8eca8f871de;hp=7305d9ffdfb3970a914015801e5348a5f1c58f18;hpb=31d85cd6b8e03c5ecc924ca8892906be1bab702f;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 7305d9f..c915c06 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -143,11 +143,11 @@ namespace connector { 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 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 @@ -155,7 +155,7 @@ namespace connector { 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(); @@ -204,7 +204,7 @@ namespace connector { 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 @@ -264,7 +264,7 @@ namespace connector { 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. */ @@ -299,7 +299,7 @@ namespace connector { 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 @@ -329,4 +329,5 @@ namespace connector { // indent-tabs-mode: nil // ispell-local-dictionary: "american" // compile-command: "scons -u test" +// comment-column: 40 // End: