X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FMainpage.dox;h=fc16dab14b63e722a23aff30aac5d5ae0ad81e3f;hb=61dc3812717cdc89fa2402006d4009236b72dc8f;hp=72b5f4b8c800f4f87b14ba89d37ca8ea3e04e04a;hpb=0990bd1c4f917855f3645e7329a84b00e54ccd7d;p=senf.git diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox index 72b5f4b..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 @@ -227,10 +231,10 @@ CopyPacketGenerator generator (stuffingPacket); senf::UDPv4ClientSocketHandle inputSocket (1111); - senf::ppi::module::ActiveSocketReader udpInput (inputSocket); + senf::ppi::module::ActiveSocketSource<> udpInput (inputSocket); senf::UDPv4ClientSocketHandle outputSocket ("2.3.4.5:2222"); - senf::ppi::module::PassiveSocketWriter udpOutput (outputSocket); + senf::ppi::module::PassiveSocketSink<> udpOutput (outputSocket); senf::ppi::module::PassiveQueue adaptor; @@ -461,7 +465,28 @@ \section ppi_classdiagram Class Diagram - \image html classes.png +
+ \ref senf::ppi::connector::PassiveConnector + \ref senf::ppi::EventManager + \ref senf::ppi::connector::ActiveOutput + \ref senf::ppi::connector::ActiveInput + \ref senf::ppi::RouteBase + \ref senf::ppi::Route + \ref (some module) + \ref senf::ppi::EventImplementation + \ref senf::ppi::module::Module + \ref senf::ppi::connector::Connector + \ref senf::ppi::connector::PassiveOutput + \ref senf::ppi::detail::EventBindingBase + \ref senf::ppi::connector::InputConnector + \ref senf::ppi::detail::RouteImplementation + \ref senf::ppi::connector::OutputConnector + \ref senf::ppi::connector::ActiveConnector + \ref senf::ppi::detail::EventBinding + \ref senf::ppi::EventDescriptor + \ref senf::ppi::connector::PassiveInput +
+ \htmlonly classes \endhtmlonly */