PcapDevice.h

Go to the documentation of this file.

#ifndef PCAPPP_PCAP_DEVICE
#define PCAPPP_PCAP_DEVICE

#include "Device.h"

#if defined(PCAPPP_MINGW_ENV) && !defined(WIN32)
#   define WIN32
#endif

// forward decleration for the pcap descriptor defined in pcap.h
struct pcap;
typedef pcap pcap_t;
struct pcap_pkthdr;


namespace pcpp
{
    //Forward Declaration - required for IPcapDevice::matchPacketWithFilter
    class GeneralFilter;

    class IPcapDevice : public IDevice, public IFilterableDevice
    {
    protected:
        pcap_t* m_PcapDescriptor;

        // c'tor should not be public
        IPcapDevice() : IDevice() { m_PcapDescriptor = NULL; }

    public:

        struct PcapStats
        {
            uint64_t packetsRecv;
            uint64_t packetsDrop;
            uint64_t packetsDropByInterface;
        };


        virtual ~IPcapDevice();

        virtual void getStatistics(PcapStats& stats) const = 0;

        static std::string getPcapLibVersionInfo();

#if __cplusplus > 201402L || _MSC_VER >= 1900
        [[deprecated("Prefer building a BPFStringFilter class and calling verifyFilter on it to check if a filter string is valid see PcapFilter.h")]]
#endif
        static bool verifyFilter(std::string filterAsString);

#if __cplusplus > 201402L || _MSC_VER >= 1900
        [[deprecated("Prefer building a GeneralFilter class and calling matchPacketWithFilter using the constructed filter. See PcapFilter.h")]]
#endif
        static bool matchPacketWithFilter(std::string filterAsString, RawPacket* rawPacket);

        static bool matchPacketWithFilter(GeneralFilter& filter, RawPacket* rawPacket);


        // implement abstract methods

        using IFilterableDevice::setFilter;

        virtual bool setFilter(std::string filterAsString);

        bool clearFilter();
    };

} // namespace pcpp

#endif // PCAPPP_PCAP_DEVICE