//
// 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>
+
/** \mainpage libPPI : The Packet Processing Infrastructure
modules.
\see \ref ppi_overview \n
- <a href="../../../Examples/RateStuffer/doc/html/index.html">PPI Example Application:
+ <a href="../../../../Examples/RateStuffer/doc/html/index.html">PPI Example Application:
RateStuffer</a> \n
\ref senf::ppi::module "Modules" \n
\ref senf::ppi::connector "Connectors and Jacks" \n
\section ppi_packets Packets
- The PPI processes packets and uses the <a href="@TOPDIR@/Packets/doc/html/index.html">Packet
- library</a> to handle them. All packets are internally passed around as generic \ref
- senf::Packet references, however connectors may optionally be defined as sending or receiving
- packets of a specific type only.
+ The PPI processes packets and uses the <a
+ href="@TOPDIR@/senf/Packets/doc/html/index.html">Packet library</a> to handle them. All packets
+ are internally passed around as generic \ref senf::Packet references, however connectors may
+ optionally be defined as sending or receiving packets of a specific type only.
\section ppi_modules Modules
It is possible to connect two active or passive connectors with each other using a special
adaptor module (senf::ppi::module::PassiveQueue or senf::ppi::module::ActiveFeeder
respectively).
-
+
Additionally, the connectors must be type-compatible: Either one (or both) of the connectors
must be untyped (they accept arbitrary senf::Packet's, the optional tempalte argument is empty),
- or they both accept the same type of packet. This check is performed at runtime.
+ or they both accept the same type of packet. This check is performed at runtime.
To complete our simplified example: Lets connect senf::ppi::module::ActiveSocketReader and
senf::ppi::module::PassiveSocketWriter to our example module:
The PPI really is not concerned, how the events are called and what information is needed to
perform the call. This is handled by the <a
- href="@TOPDIR@/Scheduler/doc/html/index.html">Scheduler</a>, which is wrapped by the event
+ href="@TOPDIR@/senf/Scheduler/doc/html/index.html">Scheduler</a>, which is wrapped by the event
classes.
All events are derived from senf::ppi::EventDescriptor. The base class allows to enable and
\section ppi_classdiagram Class Diagram
- <div class="diamap" name="classes">
- <span coords="652,428,796,455">\ref senf::ppi::connector::PassiveConnector</span>
- <span coords="198,381,316,408">\ref senf::ppi::EventManager</span>
- <span coords="462,543,571,570">\ref senf::ppi::connector::ActiveOutput</span>
- <span coords="468,494,564,521">\ref senf::ppi::connector::ActiveInput</span>
- <span coords="414,36,505,63">\ref senf::ppi::RouteBase</span>
- <span coords="432,325,529,379">\ref senf::ppi::Route</span>
- <span coords="194,154,319,181">\ref (some module)</span>
- <span coords="19,293,252,333">\ref senf::ppi::EventImplementation</span>
- <span coords="225,36,289,63">\ref senf::ppi::module::Module</span>
- <span coords="309,331,397,358">\ref senf::ppi::connector::Connector</span>
- <span coords="597,543,717,570">\ref senf::ppi::connector::PassiveOutput</span>
- <span coords="66,432,210,459">\ref senf::ppi::detail::EventBindingBase</span>
- <span coords="378,428,505,455">\ref senf::ppi::connector::InputConnector</span>
- <span coords="491,124,694,210">\ref senf::ppi::detail::RouteImplementation</span>
- <span coords="283,464,423,491">\ref senf::ppi::connector::OutputConnector</span>
- <span coords="512,428,645,455">\ref senf::ppi::connector::ActiveConnector</span>
- <span coords="85,487,259,527">\ref senf::ppi::detail::EventBinding</span>
- <span coords="39,216,170,243">\ref senf::ppi::EventDescriptor</span>
- <span coords="604,494,710,521">\ref senf::ppi::connector::PassiveInput</span>
- </div>
- \htmlonly <img src="classes.png" border="0" alt="classes" usemap="#classes"> \endhtmlonly
+ \diaimage classes.dia
*/
-
+\f
// Local Variables:
// mode: c++
// fill-column: 100
projects / senf.git / blobdiff