X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Examples%2FRateStuffer%2FMainpage.dox;h=cf8b43746d09b457e2db03c0b1fa8092550a4c10;hb=20c3dbf64b3beed10655dceaee5791680fb25383;hp=4a3eda979cb6106c3d36cdcc677c136690cc6c04;hpb=e9f3f713ebd30170474b2f3f2b060a001aa9b422;p=senf.git diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox index 4a3eda9..cf8b437 100644 --- a/Examples/RateStuffer/Mainpage.dox +++ b/Examples/RateStuffer/Mainpage.dox @@ -20,12 +20,14 @@ // Free Software Foundation, Inc., // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +using namespace senf::ppi::module; + /** \mainpage Example introducing the Packet Processing Infrastructure This example application implements a simple PPI application: It will read UDP packets from an input port and will forward them to another port at a fixed packet rate. If the input stream does not provide enough packets, empty UDP packets will be sent instead. - + \section run Running the example Running the example is a little bit more complicated since we need to provide example UDP @@ -36,7 +38,7 @@
     # nc -u -l -p 44345
     
- + The next command starts the \c ratestuffer
     # cd .../Examples/RateStuffer
@@ -60,16 +62,7 @@
 
     \section setup Module setup
 
-    
- \ref senf::ppi::module::ThrottleBarrier - \ref senf::ppi::module::PassiveQueue - \ref senf::ppi::module::PassiveSocketSink<> - \ref RateFilter - \ref senf::ppi::module::PriorityJoin - \ref senf::ppi::module::ActiveSocketSource<> - \ref senf::ppi::module::CloneSource -
- \htmlonly ratestuffer \endhtmlonly + \diaimage ratestuffer.dia Above image depicts the module setup implementing the rate stuffer. A senf::ppi::module::ActiveSocketSource reads the incoming UDP packets and sends them into a @@ -144,8 +137,8 @@ \skip class \until rateFilter - - First the needed modules are declared. We have + + First the needed modules are declared. We have - the \a barrier to discard incoming packets sent to fast - the \a queue to receive incoming packets and create throttling notifications - the \a generator to create the stuffing packets @@ -161,7 +154,7 @@ The constructor now initializes all the local objects. We pass the template \a packet to the \a generator and set the timing \a interval of the \a rateFilter. - + The \a input and \a output connector references are bound to the corresponding connectors we want to expose: \a input to the \a barrier's \a input and \a output to the \a rateFilter's \a output. @@ -194,7 +187,7 @@ \until udpSink The \ref senf::ppi::connect() calls setup the necessary connections. - + The module setup is complete, \ref senf::ppi::run() is called to enter the event loop. \until }