X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Examples%2FRateStuffer%2FMainpage.dox;h=6d034ebb56300a5f4c0186e85d9ff606f78aacc8;hb=63150647e2d71ad619a15d9d82a2b524658d755d;hp=4a3eda979cb6106c3d36cdcc677c136690cc6c04;hpb=e9f3f713ebd30170474b2f3f2b060a001aa9b422;p=senf.git diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox index 4a3eda9..6d034eb 100644 --- a/Examples/RateStuffer/Mainpage.dox +++ b/Examples/RateStuffer/Mainpage.dox @@ -2,30 +2,37 @@ // // Copyright (C) 2007 // Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY -// Stefan Bund // -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. +// The contents of this file are subject to the Fraunhofer FOKUS Public License +// Version 1.0 (the "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// http://senf.berlios.de/license.html // -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. +// The Fraunhofer FOKUS Public License Version 1.0 is based on, +// but modifies the Mozilla Public License Version 1.1. +// See the full license text for the amendments. // -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the -// Free Software Foundation, Inc., -// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +// Software distributed under the License is distributed on an "AS IS" basis, +// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License +// for the specific language governing rights and limitations under the License. +// +// The Original Code is Fraunhofer FOKUS code. +// +// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. +// (registered association), Hansastraße 27 c, 80686 Munich, Germany. +// +// Contributor(s): +// Stefan Bund + + +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 +43,7 @@
     # nc -u -l -p 44345
     
- + The next command starts the \c ratestuffer
     # cd .../Examples/RateStuffer
@@ -60,16 +67,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 +142,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 +159,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 +192,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 }