removed some useless spaces; not very important, I know :)
[senf.git] / PPI / Connectors.hh
index 52663cc..ee07dc0 100644 (file)
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institute for Open Communication Systems (FOKUS) 
-// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -44,12 +44,12 @@ namespace ppi {
 namespace connector {
 
     /** \namespace senf::ppi::connector
-        \brief Connector classes 
+        \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.
@@ -57,7 +57,7 @@ namespace connector {
         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: 
+        We therefore have 4 connector types:
         \li senf::ppi::connector::ActiveInput
         \li senf::ppi::connector::ActiveOutput
         \li senf::ppi::connector::PassiveInput
@@ -93,7 +93,7 @@ namespace connector {
         };
         \endcode
 
-        \see 
+        \see
             senf::ppi::module::Module \n
             senf::ppi::connect() \n
             \ref ppi_connectors
@@ -134,8 +134,8 @@ namespace connector {
         of connector (output or input) the respective throttling is called forward or backward
         throttling.
 
-        Passive connectors always handle two throttling states: 
-        
+        Passive connectors always handle two throttling states:
+
         \li The \e native throttling state is set manually by the module. It is the throttling state
             originating in the current module
         \li The \e forwarded throttling state is the state as it is received by throttling
@@ -143,7 +143,7 @@ namespace connector {
 
         The accumulative throttling state is generated by combining all sub-states.
      */
-    class PassiveConnector 
+    class PassiveConnector
         : public virtual Connector
     {
     public:
@@ -156,17 +156,17 @@ namespace connector {
                                              is a pointer-to-member to a member of the class which
                                              holds this input. In the second case, the pointer will
                                              automatically be bound to the containing instance.
-                                             
+
                                              \param[in] handler Handler to call, whenever an I/O
                                                  operation is to be performed. */
 
-        
+
         bool throttled() const;         ///< Get accumulative throttling state
         bool nativeThrottled() const;   ///< Get native throttling state
 
         void throttle();                ///< Set native throttling
         void unthrottle();              ///< Revoke native throttling
-        
+
         ActiveConnector & peer() const;
 
     protected:
@@ -211,7 +211,7 @@ namespace connector {
         notifications. These notifications should then either be processed by the module or be
         forwarded to other connectors.
      */
-    class ActiveConnector 
+    class ActiveConnector
         : public virtual Connector
     {
         typedef ppi::detail::Callback<>::type Callback;
@@ -287,7 +287,7 @@ namespace connector {
             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 
+    class InputConnector
         : public virtual Connector
     {
         typedef std::deque<Packet> Queue;
@@ -319,10 +319,10 @@ namespace connector {
 
     protected:
         InputConnector();
-        
+
     private:
         void enqueue(Packet p);
-        
+
         virtual void v_requestEvent();
         virtual void v_enqueueEvent();
         virtual void v_dequeueEvent();
@@ -331,14 +331,14 @@ namespace connector {
 
         friend class OutputConnector;
     };
-    
+
     /** \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
         the queueing of the connected input.
      */
-    class OutputConnector 
+    class OutputConnector
         : public virtual Connector
     {
     public:
@@ -351,7 +351,7 @@ namespace connector {
     protected:
         OutputConnector();
     };
-    
+
     /** \brief Combination of PassiveConnector and InputConnector
 
         The GenericPassiveInput automatically controls the connectors throttling state using a
@@ -361,7 +361,7 @@ namespace connector {
         <tt>ThresholdQueueing(1,0)</tt> which will throttle the input whenever the queue is
         non-empty.
      */
-    class GenericPassiveInput 
+    class GenericPassiveInput
         : public PassiveConnector, public InputConnector,
           public safe_bool<GenericPassiveInput>
     {
@@ -374,7 +374,7 @@ namespace connector {
         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 */
 
     protected: