Example.dox

   1 /** \page example Sniffer: A simple example application
   2
   3     \dontinclude Sniffer.cc
   4
   5     The Sniffer application is a simple command line network sniffer like \c tcpdump or \c
   6     tethereal. The application uses a packet socket to read Ethernet packets from the \c eth0
   7     interface and dumps the parsed packets out to the standard output.
   8
   9     To try out the example application, check out the library, go to the \c Sniffer
  10     directory and execute
  11
  12     <pre>
  13     # scons -u
  14     # ./sniffer loop
  15     < Hit Ctrl-C when you've seen enough >
  16     # ./sniffer scheduler
  17     < Hit Ctrl-C when you've seen enough >
  18     </pre>
  19
  20     We will now look at the code which is found in \c Sniffer.cc in the \c Sniffer directory. The
  21     code starts out by including the necessary headers
  22
  23     \skip // Custom includes
  24     \until membind
  25
  26     (The additional includes found in the source but not shown here are part of a short-time fix
  27     which will be removed as soon as possible). The example application now contains a helper
  28     routine to produce a packet hexdump. We will skip this routine here. The example includes two
  29     implementations, one using blocking calls and a while loop, the other using the senf::Scheduler
  30     for asynchronous event notification. They are implemented in \c loop_main() and \c
  31     scheduler_main(). They will be documented below. For now, we skip these implementations and go
  32     straight to the \c main() function
  33
  34     \skip int main(
  35     \until return 1;
  36     \until }
  37
  38     This routine simply interprets the first command line argument and dispatches to the required
  39     implementation.
  40
  41     Now lets go back and study each implementation in detail.
  42
  43     \dontinclude Sniffer.cc
  44
  45     \section example_loop A Blocking Implementation
  46
  47     This implementation is found in the \c loop_main function.
  48
  49     \skip loop_main
  50     \until try
  51
  52     We catch all exceptions in a \c try block. This is good for a deliverable binary. When debugging
  53     the application, it might be better to let the exception \c abort the execution so you can get a
  54     backtrace of the exception origin in the debugger.
  55
  56     We now create a packet socket and bind it to the \c eth0 interface. A packet socket is a linux
  57     specific type of socket which returns ethernet packets directly from the network wire. By
  58     uncommenting the last line, you may switch the interface into promiscuous mode.
  59
  60     \until //
  61
  62     We will now read packets from the socket forever, that is until the user hits Ctrl-C
  63
  64     \skip while
  65     \until read
  66
  67     The next step is, to parse the data read from the socket as an Ethernet packet
  68
  69     \until ;
  70
  71     Lets digest this line step by step: We declare a variable named \c packet as a smart pointer to
  72     an \c EthernetPacket instance. \c ptr is a typedef member of all Packet classes for the
  73     corresponding smart pointer type. We then initialize this pointer with a call to the static \c
  74     create member of the \c Packet class. This member takes the type of Packet to parse as a
  75     template argument. We pass \c EthernetPacket here. The function takes an iterator range as an
  76     argument, and we pass it the complete packet just read by giving the range \c begin() to \c
  77     end() of our just read \c data string.
  78
  79     The next step is to write out the packet to the standard output
  80
  81     \until \n\n
  82
  83     The \c dump call will write out a complete representation of the parsed packet data. The Packet
  84     library will \e not try to interpret payload data as long as no exact indication of the payload
  85     type is available (example: A UDP Payload is not parsed further unless you explicitly tell the
  86     library, how to parse it).  Tools like \c tethereal guess the payload type by checking port
  87     numbers and the payload data, however this is not advisable for a general purpose packet
  88     library.
  89
  90     The next line, \c hexdump, will write out the \e last packet component. Packets are managed as a
  91     chain of headers. The last header is normally a \c DataPacket holding the payload data.
  92
  93     That's it. We finish of by catching the exception and giving as much detail as possible if an
  94     exception is caught
  95
  96     \until ;
  97     \until }
  98     \until }
  99
 100     The \c prettyName function from the \c Utils library is used, to get a nice, printable
 101     representation of the \e dynamic type of the exception instance. It is an interface to the g++
 102     demangler. This is necessary since the \c name member of the C++ \c type_info instance is a
 103     mangled name in \c g++.
 104
 105     That's it for the simple blocking implementation.
 106
 107     \section example_scheduler Using the Scheduler
 108
 109     However, we have another one which uses the Scheduler. We do this as it will be most of the
 110     time: We define a class which manages reading the packets and dumping them out.
 111
 112     \until }
 113
 114     The class constructor binds the socket defined as a data member to the correct interface.
 115
 116     \until add
 117
 118     The public \c run() member is called to run the sniffer.  It first adds the socket to the
 119     Scheduler. The \c add() call takes two Arguments, the socket to bind to (which can be a lot of
 120     things and must not necessarily be a socket instance) and callback to call, whenever there is an
 121     event on that socket. A third argument may be specified to restrict the events, on which the
 122     function is called, here we have left out this argument which defaults to
 123     senf::Scheduler::EV_ALL.
 124
 125     The callback is specified as a <a
 126     href="http://www.boost.org/doc/html/function.html">Boost.Function</a> object. We use the \c
 127     senf::membind helper from the Utils library to build such a function object. This helper takes
 128     an arbitrary class member and binds it to a specific instance.
 129
 130     \until }
 131
 132     Calling the Schedulers \c process() method will start the event loop. This call does not return
 133     (ok, it does return in special cases if \c senf::Scheduler::terminate() is called which does not
 134     apply here).
 135
 136     \until {
 137
 138     The \c dumpPacket() member is called by the scheduler whenever an event on the socket is
 139     encountered. The scheduler always passes two arguments: The socket and an event id which
 140     identifies the type of event which triggered the call.
 141
 142     \until };
 143
 144     The body is absolutely identical to the body of the \c while loop of the blocking
 145     implementation. However, the scheduler guarantees, that a read on the socket will not block if
 146     the socket is triggered to be readable (even if the socket is not set to non-blocking mode).
 147
 148     We now only need to provide the \c scheduler_main() function to run this code
 149
 150     \until 0;
 151     \until }
 152
 153     This function is straight forward. The exception handling is the same as in \c loop_main(). The
 154     code then just creates a \c Sniffer instance and calls it's \c run() member.
 155
 156     \see \ref components \n
 157          \ref build \n
 158          <a href="../../Socket/doc/html/index.html"><b>libSocket API reference</b></a> \n
 159          <a href="../../Packets/doc/html/index.html"><b>libPackets API reference</b></a> \n
 160          <a href="../../Utils/doc/html/index.html"><b>libUtils API reference</b></a>
 161  */
 162
 163 \f
 164 // Local Variables:
 165 // mode: c++
 166 // fill-column: 100
 167 // c-file-style: "senf"
 168 // indent-tabs-mode: nil
 169 // ispell-local-dictionary: "american"
 170 // mode: flyspell
 171 // mode: auto-fill
 172 // End: