-// Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// 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
To get started using this library, begin by checking out the code from the <a
href="http://developer.berlios.de/svn/?group_id=7489">BerliOS SVN repository</a>. You may find
- help on using the library at '\ref usage'. If you are interested in SENF, feel free to subscribe
+ help on using the library at '\ref senf_usage'. If you are interested in SENF, feel free to subscribe
to the <a href="http://developer.berlios.de/mail/?group_id=7489">SENF mailing lists</a>. If you
- want to contribute, read the docs and \e please adhere to the \ref conventions.
+ want to contribute, read the docs and \e please adhere to the \ref senf_conventions.
- \see \ref usage\n
- \ref example
+ \see \ref senf_usage\n
+ <a href="../../Examples/doc/html/index.html">Examples</a>
*/
-/** \page usage Using the SENF framework
+/** \page senf_usage Using the SENF framework
The SENF Framework is a collection of loosely coupled modules. The libraries are heavily object
oriented and template based. For compatibility reasons, the libraries are therefore built
together with every project making use of the framework.
- When starting a new Projekt based on the SENF framework, it is advisable, to make use of the
+ When starting a new project based on the SENF framework, it is advisable, to make use of the
SENFSCons build environment and use SVN to manage the code repository. This is the
configuration, described in this documentation.
- \see \ref build \n
- \ref components \n
- \ref svnsetup \n
- \ref overview
+ \see \ref senf_build \n
+ \ref senf_components \n
+ \ref senf_svnsetup \n
+ \ref senf_overview
- \section Preliminaries
+ \section senf_preliminaries Preliminaries
- Before starting the devlopment, make sure to fulfill the following requirements:
+ Before starting the development, make sure to fulfill the following requirements:
\li GNU g++, version at least 3.4
\li The Boost libraries (http://www.boost.org)
\li The \c dia diagram editor (http://www.gnome.org/projects/dia/)
\li HTML \c tidy (http://tidy.sourceforge.net/)
\li The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html)
+ \li The \c graphviz library (http://www.graphviz.org)
The library is only tested with gcc-3.4 and 4.0 on Linux. On other POSIX platforms with a BSD
which relies on \c epoll)
*/
-/** \page build Building the framework
+/** \page senf_build Building the framework
This procedure will test building the complete framework including the unit tests and the
Sniffer test application. This build is \e not needed to use the framework since every project
After you have successfully built the library tests, you can continue to setup your own project
using SENF.
- \see \ref components \n
- \ref svnsetup
+ \see \ref senf_components \n
+ \ref senf_svnsetup
- \section checkout Getting the code
+ \section senf_checkout Getting the code
To access the code, check out the code from the BerliOS repository. Change to your development
directory and use the following subversion command
http://subversion.tigris.org. A very good introduction and reference to subversion is available
at http://svnbook.red-bean.com.
- \section compile Building
+ \section senf_compile Building
To build the library, execute all unit tests and build the Sniffer test application, use
are just arbitrary examples).
*/
-/** \page components The SENF modules
+/** \page senf_components The SENF modules
The framework is made up of several modular components. When using the library, it is possible
to selectively choose to use only a subset of the implemented modules.
- \see \ref build \n
- \ref svnsetup
+ \see \ref senf_build \n
+ \ref senf_svnsetup
+
+ \section libPPI libPPI: Packet Processing Infrastructure
+
+ The Packet Processing Infrastructure implements a modular framework for implementing packet
+ oriented network applications. The library provides a larget set of pre-defined modules as well
+ as the necessary helpers to implement application specific processing modules.
+
+ \see <a href="../../PPI/doc/html/index.html">libPPI API reference</a>
\section libSocket libSocket: C++ abstraction of the BSD socket API
This library provides a high performance and object oriented abstraction of the standard socket
API. It utilizes a flexible and extensible policy based design. The library provides predefined
- types for the important socket types (UDP and TCP sockets etc) including raw and packet
- sockets. \n
+ types for the important socket types (UDP and TCP sockets etc) including raw and packet sockets.
- \see <a href="../../Socket/doc/html/index.html">libSocket API
- reference</a>
+ \see <a href="../../Socket/doc/html/index.html">libSocket API reference</a>
\section libPackets libPackets: Network packet manipulation
- This libarary provides a very flexible infrastructure to parse, create and otherwise manipulate
+ This library provides a very flexible infrastructure to parse, create and otherwise manipulate
packetized network data. Included is a library of several protocol parsers covering the basic
IPv4 and IPv6 network protocols down to the Ethernet layer.
- \see <a href="../../Packets/doc/html/index.html">libPackets API
- reference</a>
+ \see <a href="../../Packets/doc/html/index.html">libPackets API reference</a>
\section libScheduler libScheduler: Asynchronous event handling
\see <a href="../../senfscons/doc/html/index.html">SENFSCons reference</a>
*/
-/** \page svnsetup Setting up a new project using SENF
+/** \page senf_svnsetup Setting up a new project using SENF
The preferred way to use SENF in a new project is to rely on Subversion and make use of the
SENFSCons build environment. The following sections will describe, how this setup works.
- \see \ref build \n
- \ref components \n
- \ref overview
+ \see \ref senf_build \n
+ \ref senf_components \n
+ \ref senf_overview
\section svnext Setting up the project repository
You now have to decide, which modules you want to use. Every module resides in it's own
subdirectory in the SENF repository. Instead of directly checking out the code, we will use \c
- svn:externals. This will instruct \c svn to auutomatically check out the needed directories from
+ svn:externals. This will instruct \c svn to automatically check out the needed directories from
the BerliOS SENF repository. Change to the 'Foo' directory and type
<pre>
The default editor (probably VI) will be started with the current value of the svn:externals
property (which will probably be empty). Now add all the modules you want plus \c senfscons and
- possibly \c doclib (if you want to build the documentation). You will almost certainly neeed the
+ possibly \c doclib (if you want to build the documentation). You will almost certainly need the
\c Utils module, since all other modules depend on it.
For example, if you want to use the \c Scheduler and \c Socket module, the file will look like
and the code will be checked out into the corresponding directories.
- \section new_conf Configuring SENFSCons
+ \section senf_new_conf Configuring SENFSCons
To set up the build environment, copy the <tt>senfscons/SConstruct.template</tt> to
<tt>SConstruct</tt> in the project root. The default setup of this file is to build all
- subdirectories (using the \c SConscript files of the subdirectories). You can add additonal
+ subdirectories (using the \c SConscript files of the subdirectories). You can add additional
global targets and configuration parameters here.
If you want to use a non-default compiler or the boost library is not installed in the system
$ scons
</pre>
- If you have not changed the \c SConstruct file, this will build all modules you have importet
+ If you have not changed the \c SConstruct file, this will build all modules you have imported
into your project. To build and execute the unit tests, use
<pre>
</pre>
\see <a href="../../senfscons/doc/html/index.html">SENFSCons reference</a> \n
- <a class="ext" href="http://www.scons.org/documentation.php">SCons documentation</a> \n
- <a class="ext" href="http://svnbook.red-bean.com">Subversion online book</a> \n
- <a class="ext" href="http://subversion.tigris.org">Subversion Homepage</a>
+ <a href="http://www.scons.org/documentation.php">SCons documentation</a> \n
+ <a href="http://svnbook.red-bean.com">Subversion online book</a> \n
+ <a href="http://subversion.tigris.org">Subversion Homepage</a>
*/
-/** \page overview Introduction to the framework
+/** \page senf_overview Introduction to the framework
The SENF framework is relatively complex and makes use of advanced features of the C++
language. To make the most efficient use of the framework, you should have at least a basic
standard library. It is designed, to integrate well into both libraries and to use the same
concepts and ideas.
- \section startup Getting starting developing with SENF
+ \section senf_startup Getting starting developing with SENF
To introduce the framework and it's general structure, a simple example application is provided
in the SENF repository in the \c Sniffer module. Peruse this example to get a first look at how
The simplest way to get started is: copy the Sniffer application and start to modify it.
- \see \ref example \n
- \ref components \n
- \ref svnsetup \n
- \ref build
+ \see <a href="../../Examples/doc/html/index.html">Examples</a> \n
+ \ref senf_components \n
+ \ref senf_svnsetup \n
+ \ref senf_build
- \section conventions Coding Conventions
+ \section senf_conventions Coding Conventions
Here we have laid down the coding conventions used throughout the SENF framework. Please ad here
to these conventions when changing or adding code. If you use emacs, you can use the C++ IDE for
emacs from http://g0dil.de which greatly simplifies following these conventions.
- \subsection conventions_file_naming File Naming
+ \subsection senf_conventions_file_naming File Naming
Files should be named according to the main class they define. A single header file should
define only one main class. Exceptions to this rule are OK.
<tr><td>\c .cci</td><td>C++ implementation of inline non-template functions and
members</td></tr>
- <tr><td>\c .cti</td><td>C++ implementation of inline template fuanctions and members</td></tr>
+ <tr><td>\c .cti</td><td>C++ implementation of inline template functions and members</td></tr>
<tr><td>\c .mpp</td><td>Special include file used for external iteration by the
Boost.Preprocessor library</td></tr> </table>
an implementation from one of the inline files into one of the non-inline files will change
the type of implementation accordingly.
- \subsection conventions_type_naming Type Naming
+ \subsection senf_conventions_type_naming Type Naming
SENF prefers the use of the CapitalziedLettersToSeparateWords convention for class names. In
this case, class names must start with a capital letter. There are some exceptions to this rule:
name. This can also be used by the editor to highlight type names correctly. Additionally,
this convention is compact and does not add additional or repeated overhead.
- \subsection conventions_impl Implementation
+ \subsection senf_conventions_impl Implementation
Only in very few places, SENF allows the use of inline implementations (not to be confused with
inline functions). An \e implementation is inline, if it is written directly into the class
Together with splitting inlines and non-inlines into separate files, this allows to
automatically include the inline definitions at the right places. See above.
+ Private data members are named with a trailing underscore character.
+
+ \par Rationale:
+ This helps distinguishing local variables from parameter names. The trailing underscore
+ does not interfere with other naming conventions and is allowed by the standard (underscore
+ at the beginning of the name are problematic since some classes of names beginning with an
+ underscore are reserved for the standard library implementation)
*/
\f
projects / senf.git / blobdiff