X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=4779c3036681867519389053c241dcfb2c46f043;hb=ae06fe86f16fdabb7ffb219d255444d2eb4f4f79;hp=e42bab9172e744f2ea7c6fdc1956f1b2d7a5f759;hpb=e84dd6c52a07fc9e283cbd72c7616f3523920387;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index e42bab9..4779c30 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -55,8 +55,19 @@ namespace connector { All passive connectors call some onRequest callback whenever I/O needs to be performed. All input modules possess a packet queue. - We therefore have 4 connector types: senf::ppi::ActiveInput, senf::ppi::ActiveOutput, - senf::ppi::PassiveInput and senf::ppi::PassiveOutput. + We therefore have 4 connector types: + \li senf::ppi::connector::ActiveInput + \li senf::ppi::connector::ActiveOutput + \li senf::ppi::connector::PassiveInput + \li senf::ppi::connector::PassiveOutput. + + Connectors are declared as module data members and are then externally connected to other + modules. + + \see + senf::ppi::module::Module \n + senf::ppi::connect() + \ref ppi_connectors */ /** \brief Connector base-class @@ -266,7 +277,7 @@ namespace connector { logic error in the module implementation and an exception is raised. */ - Packet read(); ///< Alias for \ref operator()() + Packet read(); ///< Alias for operator()() OutputConnector & peer() const; @@ -304,7 +315,7 @@ namespace connector { public: void operator()(Packet p); ///< Send out a packet - void write(Packet p); ///< Alias for \ref operator()() + void write(Packet p); ///< Alias for operator()(Packet p) InputConnector & peer() const;