Packets: Keep annotation registry sorted by type name
[senf.git] / Examples / RateStuffer / Mainpage.dox
index 4a3eda9..cf8b437 100644 (file)
 // 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 @@
     <pre>
     # nc -u -l -p 44345
     </pre>
-    
+
     The next command starts the \c ratestuffer
     <pre>
     # cd .../Examples/RateStuffer
 
     \section setup Module setup
 
-    <div class="diamap" name="ratestuffer">
-        <span coords="101,139,220,206">\ref senf::ppi::module::ThrottleBarrier</span>
-        <span coords="241,152,365,219">\ref senf::ppi::module::PassiveQueue</span>
-        <span coords="606,346,748,400">\ref senf::ppi::module::PassiveSocketSink<></span>
-        <span coords="528,190,647,257">\ref RateFilter</span>
-        <span coords="387,165,511,245">\ref senf::ppi::module::PriorityJoin</span>
-        <span coords="0,0,149,53">\ref senf::ppi::module::ActiveSocketSource<></span>
-        <span coords="241,235,365,289">\ref senf::ppi::module::CloneSource</span>
-    </div>
-    \htmlonly <img src="ratestuffer.png" border="0" alt="ratestuffer" usemap="#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
 
     \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
 
     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.
     \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 }