X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FModule.hh;h=30d52d9892a1d290811674bddc4e810b69cbb219;hb=cb10487f67b404334eaffa60f074b8eca8f871de;hp=6d3d634ac9c6f9870f21f086a5787dbb31c2bf69;hpb=89efe5f504c400212090aba703c7ee385f483c64;p=senf.git diff --git a/PPI/Module.hh b/PPI/Module.hh index 6d3d634..30d52d9 100644 --- a/PPI/Module.hh +++ b/PPI/Module.hh @@ -34,6 +34,7 @@ namespace senf { namespace ppi { +namespace module { /** \brief Module baseclass @@ -78,9 +79,9 @@ 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 */ @@ -97,7 +98,7 @@ namespace ppi { \param[in] connector Terminal connector to declare */ template - typename Descriptor & registerEvent(Target target, Descriptor const & descriptor); + void registerEvent(Target target, Descriptor const & descriptor); ///< Register an external event /**< The \a target argument may be either an arbitrary callable object or it may be a member function pointer @@ -111,32 +112,14 @@ namespace ppi { 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 */ - \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. */ - - boost::posix_time::ptime eventTime(); ///< Return timestamp of the currently processing event + boost::posix_time::ptime eventTime(); ///< Return timestamp of the currently processing + ///< event }; - /** \brief Automatically manage dynamic module deallocation - - The dynamicModule helper will create a new dynamically managed module instance. - - The \a args template parameter is only a placeholder. All arguments to dynamicModule will be - passed to the Module constructor. - */ - template - unspecified dynamicModule(Args args); - - /** \brief Connect compatible connectors connect() will connect two compatible connectors: One connector must be active, the other @@ -145,18 +128,7 @@ namespace ppi { template void connect(Source const & source, Target const & target); - /** \brief Connect connectors via an adaptor module - - This connect() overload will insert an additional adaptor module into the connection. The - Adaptor module must have two connectors, \a input and \a output. The call will setup the - connections \a source to \a input and \a output to \a target. Each connector pair must be - compatible. - */ - template