X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FModule.hh;h=1a3d22bd1d81d07bd504292c5939d0d3c48172d9;hb=81ffa1c459b96dd44472bcef37e1e373934ee138;hp=aefe9a1aee51948c2a130e5abbdd0c414cfffda7;hpb=a4887e674af3fce4180cf7e14bedace928962025;p=senf.git diff --git a/PPI/Module.hh b/PPI/Module.hh index aefe9a1..1a3d22b 100644 --- a/PPI/Module.hh +++ b/PPI/Module.hh @@ -19,19 +19,25 @@ // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. /** \file - \brief Module public header */ + \brief Module public header +*/ #ifndef HH_Module_ #define HH_Module_ 1 // Custom includes +#include #include +#include +#include +#include "predecl.hh" //#include "Module.mpp" ///////////////////////////////hh.p//////////////////////////////////////// namespace senf { namespace ppi { +namespace module { /** \brief Module baseclass @@ -39,7 +45,7 @@ namespace ppi { with interfaces to several PPI facilities: \li Connector management - \li Flow management + \li Flow management (routing) \li Event handling To provide internal bookkeeping, most access to the PPI infrastructure is managed through @@ -53,10 +59,10 @@ namespace ppi { { protected: Module(); - ~Module(); template - Route route(Source const & source, Target const & target); ///< Define flow information + Route & route(Source & source, Target & target); + ///< Define flow information /**< Using the route() and noroute() members, the information flow within the module is defined. Routing may be specified either between inputs, outputs and @@ -74,30 +80,26 @@ namespace ppi { The return value may be used to alter routing parameters like throttling parameters. - - \param[in] source Data source, object which controlls + + \param[in] source Data source, object which controls incoming data - \param[in] target Data target, object which controlls + \param[in] target Data target, object which controls outgoing data \returns Route instance describing this route */ - template - void noroute(Connector const & connector); ///It is mandatory to define routing - information for terminal connectors. - - See the route() documentation for more on routing + void noroute(connector::Connector & connector); ///< Define terminal connectors + /**< The noroute() member explicitly declares, that a + connector is terminal and does not directly + receive/forward data from/to some other + connector. It is mandatory to define routing + information for terminal connectors. - \param[in] connector Terminal connector to declare */ + See the route() documentation for more on routing + + \param[in] connector Terminal connector to declare */ template - typename Descriptor::EventBinding const registerEvent(Target target, - Descriptor const & descriptor); + void registerEvent(Target target, Descriptor & descriptor); ///< Register an external event /**< The \a target argument may be either an arbitrary callable object or it may be a member function pointer @@ -108,27 +110,46 @@ namespace ppi { information on the event delivered. The \a descriptor describes the event to signal. This + may be a timer event or some type of I/O event on a file descriptor or socket. - The return value may be used to modify the - binding. This allows to temporarily inhibit event - delivery or to remove the binding explicitly. Depending - on the type of event, other operations may be - possible. See the event descriptor documentation. - - \param[in] target The handler to call whenever the event - is signaled - \param[in] descriptor The type of event to register - \returns An event binding instance of the appropriate - type. */ + \param[in] target The handler to call whenever the + event is signaled + \param[in] descriptor The type of event to register */ + + boost::posix_time::ptime eventTime(); ///< Return timestamp of the currently processing + ///< event + + private: + EventManager & eventManager(); + + void registerConnector(connector::Connector & connector); + RouteBase & addRoute(std::auto_ptr route); + + typedef std::vector ConnectorRegistry; + ConnectorRegistry connectorRegistry_; + + typedef boost::ptr_vector RouteInfoBase; + RouteInfoBase routes_; + + template + friend class detail::RouteHelper; }; -}} + /** \brief Connect compatible connectors + + connect() will connect two compatible connectors: One connector must be active, the other + passive. + */ + template + void connect(Source const & source, Target const & target); + +}}} ///////////////////////////////hh.e//////////////////////////////////////// -//#include "Module.cci" -//#include "Module.ct" +#include "Module.cci" +#include "Module.ct" //#include "Module.cti" #endif @@ -139,4 +160,6 @@ namespace ppi { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" +// compile-command: "scons -u test" +// comment-column: 40 // End: