X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FMainpage.dox;h=2219cdef543f9278e511e2be769445ab4e9f70b4;hb=aab64270dd15a9b9a3e7dc61e076d32b6bc5c66d;hp=2cd9212b636c57d55cb770443825735cd2beb7ef;hpb=7231c220a7332754de3d16e4e8aacd5dbd31c501;p=senf.git diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox index 2cd9212..2219cde 100644 --- a/PPI/Mainpage.dox +++ b/PPI/Mainpage.dox @@ -20,9 +20,8 @@ /** \mainpage libPPI : The Packet Processing Infrastructure - The PPI provides an infrastructure to create packet oriented network processing - applications. A PPI application is built by combining processing modules in a very flexible - manner. + The PPI provides an infrastructure to create packet oriented network processing applications. A + PPI application is built by combining processing modules in a very flexible manner. \image html scenario.png Target Scenario @@ -41,6 +40,16 @@ performance optimizations for TCP traffic (PEP). This router is built by combining several modules. + \see \ref overview \n + PPI Example Application: + RateStuffer \n + \ref senf::ppi::module "Modules" \n + \ref senf::ppi::connector "Connectors" \n + \ref event_group + */ + +/** \page overview PPI Overview and Concepts + \section design Design considerations The PPI interface is designed to be as simple as possible. It provides sane defaults for all @@ -331,11 +340,10 @@ route statement as defining the 'conceptual data flow' since this is also how control messages should flow (sans the direction, which is defined by the connectors active/passive property). - \see \ref ppi_implementation \n - Implementation plan + \see \ref ppi_implementation */ -/** \page ppi_implementation Implementation Overview +/** \page ppi_implementation Implementation Notes \section processing Data Processing @@ -394,9 +402,6 @@ \section class_diagram Class Diagram \image html classes.png - - \fixme Implement Spliters: PassiveSplitter, PrioritySplitter, CloneSplitter - \fixme Implement DiscardSink, CloneSource */