X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FMainpage.dox;h=fc16dab14b63e722a23aff30aac5d5ae0ad81e3f;hb=c45c112ae88196ea8da9c5a9efb0e167196744d2;hp=2491f501ada326031939215adb0743e7bbb5fa83;hpb=e57e1ec99a16261d1f436d1ea42f60dda6aae5cc;p=senf.git diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox index 2491f50..fc16dab 100644 --- a/PPI/Mainpage.dox +++ b/PPI/Mainpage.dox @@ -47,7 +47,7 @@ PPI Example Application: RateStuffer \n \ref senf::ppi::module "Modules" \n - \ref senf::ppi::connector "Connectors" \n + \ref senf::ppi::connector "Connectors and Jacks" \n \ref event_group */ @@ -216,8 +216,12 @@ It is possible to connect two active or passive connectors with each other using a special adaptor module (senf::ppi::module::PassiveQueue or senf::ppi::module::ActiveFeeder respectively). + + Additionally, the connectors must be type-compatible: Either one (or both) of the connectors + must be untyped (they accept arbitrary senf::Packet's, the optional tempalte argument is empty), + or they both accept the same type of packet. This check is performed at runtime. - To complete our simplified example: Lets connet senf::ppi::module::ActiveSocketReader and + To complete our simplified example: Lets connect senf::ppi::module::ActiveSocketReader and senf::ppi::module::PassiveSocketWriter to our example module: \code @@ -461,7 +465,28 @@ \section ppi_classdiagram Class Diagram - \image html classes.png +