X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Examples%2FSniffer%2FMainpage.dox;h=3f88daff676d333a4e6d45872c05b0c6c97fa455;hb=961cf85a6abf2b5f0a7958bbfcd8f72e7b32721b;hp=5d59420e30dbf47605e91ce595ccc3dd8cff54d8;hpb=7fe2d6a5663e7723b8f646333e17fe4ba2a1b77a;p=senf.git diff --git a/Examples/Sniffer/Mainpage.dox b/Examples/Sniffer/Mainpage.dox index 5d59420..3f88daf 100644 --- a/Examples/Sniffer/Mainpage.dox +++ b/Examples/Sniffer/Mainpage.dox @@ -46,8 +46,8 @@ \until #include 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 + 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( @@ -73,7 +73,7 @@ backtrace of the exception origin in the debugger. 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 + 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 // @@ -88,7 +88,7 @@ \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 @@ -139,9 +139,10 @@ The senf::scheduler::FdEvent constructor takes several arguments: \li a string describing the event. \li the callback to call whenever the event occurs. The callback is specified as a Boost.Function object. We use the \c - senf::membind helper from the Utils library to build such a function object. This helper - takes an arbitrary class member and binds it to a specific instance. + href="http://www.boost.org/doc/libs/release/doc/html/function.html">Boost.Function + object. We use the \c senf::membind helper from the Utils library to build such a + function object. This helper takes an arbitrary class member and binds it to a specific + instance. \li the handle or file descriptor to monitor. \li and the events to watch for.