PPI: Add optional template arg for packet type to connectors
[senf.git] / PPI / ActiveFeeder.hh
index a545050..91f7528 100644 (file)
@@ -1,8 +1,8 @@
 // $Id$
 //
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -38,13 +38,24 @@ namespace senf {
 namespace ppi {
 namespace module {
 
+    /** \brief Adapter to connect passive connectors
+
+        ActiveFeeder is an adapter module which allows to connect to passive connectors. As long as
+        none of the connectors is throttled, the ActiveFeeder will forward packets from it's input
+        to it's output.
+
+        \note For this Module to work correctly, it is very important for the connectors to be
+            correctly throttled. Otherwise the system might well hang in an endless loop.
+
+        \ingroup adapter_modules
+     */
     class ActiveFeeder
         : public Module
     {
         SENF_PPI_MODULE(ActiveFeeder);
     public:
-        connector::ActiveInput input;
-        connector::ActiveOutput output;
+        connector::ActiveInput<> input;
+        connector::ActiveOutput<> output;
 
         ActiveFeeder();