X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FMainpage.dox;h=2219cdef543f9278e511e2be769445ab4e9f70b4;hb=739eecfbeffc911e700660864ff1d7f05c6283d0;hp=5bac7810eb6ae8790fbd05526d9b17017e4e80a3;hpb=81ffa1c459b96dd44472bcef37e1e373934ee138;p=senf.git
diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox
index 5bac781..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
@@ -165,6 +174,8 @@
\section connections Connections
+ \image html ratestuffer.png Simple RateStuffer
+
To make use of the modules, they have to be instantiated and connections have to be created
between the I/O connectors. It is possible to connect any pair of input/output connectors as
long as one of them is active and the other is passive.
@@ -329,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