switch to new MPL based Fraunhofer FOKUS Public License

[senf.git] / Examples / RateStuffer / Mainpage.dox

diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox
index 4a3eda9..6d034eb 100644 (file)
--- 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 <g0dil@berlios.de>
 //
-// 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 <g0dil@berlios.de>
+
+
+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 @@
     <pre>
     # nc -u -l -p 44345
     </pre>
-    
+
     The next command starts the \c ratestuffer
     <pre>
     # cd .../Examples/RateStuffer
@@ -60,16 +67,7 @@
 
     \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
@@ -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 }