X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Examples%2FRateStuffer%2FMainpage.dox;h=4a3eda979cb6106c3d36cdcc677c136690cc6c04;hb=5443435c4c2b6e4386c5334b5b8358273f2bae93;hp=fcc730367bc583911d509bb0d2eca0a3ef14efb1;hpb=6a9425b523ea9a2bd41103dd10659ac8c7c0d080;p=senf.git
diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox
index fcc7303..4a3eda9 100644
--- a/Examples/RateStuffer/Mainpage.dox
+++ b/Examples/RateStuffer/Mainpage.dox
@@ -60,7 +60,16 @@
\section setup Module setup
- \image html ratestuffer.png
+
+ \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
\endhtmlonly
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
@@ -70,7 +79,7 @@
\a generator is fed as second input into the \a join to provide the stuffing packets.
The RateFilter \a rateFilter reads packets from it's input at a fixed rate and writes them into
- the senf::ppi::module::PassiveSocketWriter \a udpWriter. The senf::ppi::module::PriorityJoin
+ the senf::ppi::module::PassiveSocketSink \a udpSink. The senf::ppi::module::PriorityJoin
ensures that read requests of the RateStuffer's input are always serviced, either from the \a
queue or, if the \a queue output is throttled, from the \a generator.
@@ -137,11 +146,11 @@
\until rateFilter
First the needed modules are declared. We have
- \li the \a barrier to discard incoming packets sent to fast
- \li the \a queue to receive incoming packets and create throttling notifications
- \li the \a generator to create the stuffing packets
- \li the \a join to combine the input stream from the \a queue with the stuffing packet stream
- \li the \a rateFilter to generate the fixed rate output stream
+ - 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 \a join to combine the input stream from the \a queue with the stuffing packet stream
+ - the \a rateFilter to generate the fixed rate output stream
\until output
@@ -172,15 +181,15 @@
The \a inputSocket is listening on port 44344 while the \a outputSocket will send packets to
port 44345 on localhost. The \a outputSocket uses the senf::ConnectedUDPv4SocketProtocol which
- is compatible with the senf::ppi::module::PassiveSocketWriter module.
+ is compatible with the senf::ppi::module::PassiveSocketSink module.
\until udpSink
Here we allocate the components:
- \li \a udpReader to read the packets from \a inputSocket
- \li \a stuffer for the real work and
- \li \a udpWriter to send the packets to \a outputSocket
+ - \a udpSource to read the packets from \a inputSocket
+ - \a stuffer for the real work and
+ - \a udpSink to send the packets to \a outputSocket
\until udpSink