Next: , Previous: Programs, Up: Top


2 The library

A C++ library also compose WiPal. WiPal programs all use this library. At a low level it provides various convenience tools (PCAP file input/output, random access to PCAP traces, support for various static C++ techniques, etc.) At an upper level it provides a generic IEEE 802.11 frame parser that is easy to customize and re-use. Finally, it provides various mechanisms to synchronize and merge PCAP traces directly from C++ code.

The library is called libwipal and its headers are located in $(prefix)/include/wipal. You should be able to include them as follows:

     #include <wipal/pcap/stream.hh>
     // ...

You will then need to provide the -lwipal option to your compiling/linking tools.

The main documentation for this library is provided as a Doxygen documentation. It should be installed into WiPal's package data directory, into the doxygen subdirectory. By default this gives /usr/local/share/wipal/doxygen/. This documentation is however a bit messy, and lacks some parts. The best entry point to learn how to use the library is to look at some of WiPal's tools' source code (e.g. into src/misc/wipal-find-data-dups.cc). You may also want to have a look at WScout which is another program that uses WiPal (some versions of WScout embeds WiPal under the name trace-tools).