X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FModule.hh;h=b2b3ecdc82c74315ae5fa26509f493f25f4ab313;hb=b89e3166f7680755683dccee5e48cb3a820185c0;hp=03fa40f7d7417d675f731f436f9102240b85869c;hpb=a479735a65e334af538b895f182f8efd36a541c5;p=senf.git

diff --git a/PPI/Module.hh b/PPI/Module.hh
index 03fa40f..b2b3ecd 100644
--- a/PPI/Module.hh
+++ b/PPI/Module.hh
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// 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
@@ -22,8 +24,8 @@
     \brief Module public header 
 */
 
-#ifndef HH_Module_
-#define HH_Module_ 1
+#ifndef HH_SENF_PPI_Module_
+#define HH_SENF_PPI_Module_ 1
 
 // Custom includes
 #include <vector>
@@ -31,6 +33,7 @@
 #include <boost/ptr_container/ptr_vector.hpp>
 #include "../Scheduler/ClockService.hh"
 #include "predecl.hh"
+#include "ModuleManager.hh"
 
 //#include "Module.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -58,8 +61,6 @@ namespace module {
         \li \ref io_modules receive external data or forward packets out of the PPI
         \li \ref routing_modules forward packets within the network
         \li \ref adapter_modules are used to connect incompatible connectors to each other
-
-        \todo Implement Spliters: PassiveSplitter, PrioritySplitter, CloneSplitter
      */
 
     /** \defgroup io_modules Source/Sink Modules
@@ -104,8 +105,8 @@ namespace module {
         public:
             // Define connectors. Any number and type of connectors may be defined. Connectors
             // must be public since they need to be accessed to connect modules with each other.
-            senf::ppi::connector::PassiveInput input;
-            senf::ppi::connector::ActiveOutput output;
+            senf::ppi::connector::PassiveInput<> input;
+            senf::ppi::connector::ActiveOutput<> output;
 
             SomeModule(senf::FileHandle h) 
               : handle ( h ), 
@@ -155,6 +156,13 @@ namespace module {
                 event.enable();
             }
 
+            void v_init() {
+                // Optional. Called after before running the module but after connections have been
+                // set up. This is either directly before senf::ppi::run() or senf::ppi::init() is
+                // called or, for modules created while the PPI is already running, after returning
+                // from all event handlers but before going back to the event loop.
+            }
+
         };
         \endcode
 
@@ -165,7 +173,7 @@ namespace module {
         \see \ref ppi_modules
      */
     class Module
-        : boost::noncopyable
+        : ModuleManager::Initializable, boost::noncopyable
     {
     public:
         virtual ~Module();
@@ -198,9 +206,9 @@ namespace module {
                                              The return value may be used to alter routing
                                              parameters like throttling parameters.
 
-                                             \param[in] source Data source, object which controls
+                                             \param[in] input Data source, object which controls
                                                  incoming data (connector or event)
-                                             \param[in] target Data target, object which controls
+                                             \param[in] output Data target, object which controls
                                                  outgoing data (connector or event)
                                              \returns Route instance describing this route 
                                              \see \ref ppi_throttling
@@ -227,10 +235,10 @@ namespace module {
         route(EventDescriptor & input, connector::OutputConnector & output);
                                         ///< Define flow information
                                         /**< Route from an event to a connector. Routing from an
-                                             event to a connector defeines the event as the
-                                             conceptual 'source' of the data. THis means, the event
+                                             event to a connector defines the event as the
+                                             conceptual 'source' of the data. This means, the event
                                              controls how packets are sent (Example: Routing from an
-                                             IOEVent to an output defines, that output data will be
+                                             IOEvent to an output defines, that output data will be
                                              generated whenever the event is signaled).
 
                                              This event routing allows to automatically
@@ -287,7 +295,13 @@ namespace module {
 
     private:
 #endif
-        virtual void init();            ///< Called just before the network is run
+        virtual void v_init();          ///< Called after module setup
+                                        /**< This member is called directly before the PPI (resumes)
+                                             execution. It is called after connections have been
+                                             setup before entering the PPI main loop. 
+
+                                             You may overload this member. Your overload should
+                                             always call the base-class implementation. */
 
 #ifndef DOXYGEN
     public: