X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSetup.hh;h=7ca50683275964384c53777cf74712ce8d871e1a;hb=b89e3166f7680755683dccee5e48cb3a820185c0;hp=9a06fa4e2a1be5cb3541add1f7eea9602e97202f;hpb=412024ed31a4ab4eaea7a4165a434f8efebee325;p=senf.git diff --git a/PPI/Setup.hh b/PPI/Setup.hh index 9a06fa4..7ca5068 100644 --- a/PPI/Setup.hh +++ b/PPI/Setup.hh @@ -37,6 +37,8 @@ namespace senf { namespace ppi { +#ifdef DOXYGEN + /** \brief Connect modules senf::ppi::connect() establishes a connection between two modules or, to be more precise, @@ -52,33 +54,43 @@ namespace ppi { \li Either or both of the connectors are untyped (they accept/send arbitrary senf::Packet's) \li Both connectors send/accept the exactly same packet type. + Depending on the type of input or output, the connect call may require additional + arguments. See the respective module documentation for more information + \throws connector::IncompatibleConnectorsException if the two connectors are not type compatible. \see \ref ppi_connections */ - void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target); + void connect(connector::OutputConnector & source, connector::InputConnector & target, ...); - /** \brief Connect modules - \see connect() */ +#else + + void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target); void connect(connector::GenericPassiveOutput & source, connector::GenericActiveInput & target); +#endif + #ifndef DOXYGEN template void connect(T & source, C & target, typename boost::disable_if< boost::is_base_of >::type * = 0, - typename boost::enable_if< boost::is_base_of >::type * = 0); + typename boost::enable_if< boost::is_base_of >::type * = 0, + typename boost::disable_if< boost::is_base_of >:: type * = 0); template void connect(C & source, T & target, typename boost::enable_if< boost::is_base_of >::type * = 0, - typename boost::disable_if< boost::is_base_of >::type * = 0); + typename boost::disable_if< boost::is_base_of >::type * = 0, + typename boost::disable_if< boost::is_base_of >:: type * = 0); template void connect(T1 & source, T2 & target, typename boost::disable_if< boost::is_base_of >::type * = 0, - typename boost::disable_if< boost::is_base_of >::type * = 0); + typename boost::disable_if< boost::is_base_of >::type * = 0, + typename boost::disable_if< boost::is_base_of >:: type * = 0, + typename boost::disable_if< boost::is_base_of >:: type * = 0); #endif