// $Id$
//
-// Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-/** \mainpage Sniffer: A simple example application
+/** \mainpage Simple packet sniffer reading and dumping raw network packets
\dontinclude Sniffer.cc
code starts out by including the necessary headers
\skip // Custom includes
- \until membind
+ \until #include <senf/Scheduler/Scheduler.hh>
- (The additional includes found in the source but not shown here are part of a short-time fix
- which will be removed as soon as possible). The example application now contains a helper
- routine to produce a packet hexdump. We will skip this routine here. The example includes two
- implementations, one using blocking calls and a while loop, the other using the senf::Scheduler
- for asynchronous event notification. They are implemented in \c loop_main() and \c
- scheduler_main(). They will be documented below. For now, we skip these implementations and go
- straight to the \c main() function
+ The example includes two implementations, one using blocking calls and a while loop, the other
+ using the senf::Scheduler for asynchronous event notification. They are implemented in
+ \c loop_main() and \c scheduler_main(). They will be documented below. For now, we skip these
+ implementations and go straight to the \c main() function
\skip int main(
\until return 1;
the application, it might be better to let the exception \c abort the execution so you can get a
backtrace of the exception origin in the debugger.
- We now create a packet socket and bind it to the \c eth0 interface. A packet socket is a linux
- specific type of socket which returns ethernet packets directly from the network wire. By
- uncommenting the last line, you may switch the interface into promiscuous mode.
+ We now create a packet socket and bind it to the interface given as second command line argument.
+ A packet socket is a linux specific type of socket which returns ethernet packets directly from
+ the network wire. By uncommenting the last line, you may switch the interface into promiscuous mode.
\until //
We will now read packets from the socket forever, that is until the user hits Ctrl-C
\skip while
- \until read
+ \until while
The next step is, to parse the data read from the socket as an Ethernet packet
- \until ;
+ \until sock.read
+ \doc the following section is obsolete!
+
Lets digest this line step by step: We declare a variable named \c packet as a smart pointer to
an \c EthernetPacket instance. \c ptr is a typedef member of all Packet classes for the
corresponding smart pointer type. We then initialize this pointer with a call to the static \c
representation of the \e dynamic type of the exception instance. It is an interface to the g++
demangler. This is necessary since the \c name member of the C++ \c type_info instance is a
mangled name in \c g++.
-
- That's it for the simple blocking implementation.
+
+ That's it for the simple blocking implementation.
\section example_scheduler Using the Scheduler
Calling the Schedulers \c process() method will start the event loop. This call does not return
(ok, it does return in special cases if \c senf::Scheduler::terminate() is called which does not
apply here).
-
+
\until {
The \c dumpPacket() member is called by the scheduler whenever an event on the socket is
This function is straight forward. The exception handling is the same as in \c loop_main(). The
code then just creates a \c Sniffer instance and calls it's \c run() member.
- \see \ref components \n
- \ref build \n
+ \see \ref senf_components \n
+ \ref senf_build \n
<a href="../../../../Socket/doc/html/index.html"><b>libSocket API reference</b></a> \n
<a href="../../../../Packets/doc/html/index.html"><b>libPackets API reference</b></a> \n
<a href="../../../../Utils/doc/html/index.html"><b>libUtils API reference</b></a>
projects / senf.git / blobdiff