libraries/pcappp/include/pcapplusplus/PcapLiveDeviceList.h

122 lines
3.8 KiB
C++

#ifndef PCAPPP_LIVE_DEVICE_LIST
#define PCAPPP_LIVE_DEVICE_LIST
#include "IpAddress.h"
#include "PcapLiveDevice.h"
#include <vector>
/// @file
/**
* \namespace pcpp
* \brief The main namespace for the PcapPlusPlus lib
*/
namespace pcpp
{
/**
* @class PcapLiveDeviceList
* A singleton class that creates, stores and provides access to all PcapLiveDevice (on Linux) or WinPcapLiveDevice (on Windows) instances. All live
* devices are initialized on startup and wrap the network interfaces installed on the machine. This class enables access to them through
* their IP addresses or get a vector of all of them so the user can search them in some other way
*/
class PcapLiveDeviceList
{
private:
std::vector<PcapLiveDevice*> m_LiveDeviceList;
std::vector<IPv4Address> m_DnsServers;
// private c'tor
PcapLiveDeviceList();
// private copy c'tor
PcapLiveDeviceList( const PcapLiveDeviceList& other );
PcapLiveDeviceList& operator=(const PcapLiveDeviceList& other);
void init();
void setDnsServers();
public:
/**
* The access method to the singleton
* @return The singleton instance of this class
*/
static PcapLiveDeviceList& getInstance()
{
static PcapLiveDeviceList instance;
return instance;
}
/**
* @return A vector containing pointers to all live devices currently installed on the machine
*/
const std::vector<PcapLiveDevice*>& getPcapLiveDevicesList() const { return m_LiveDeviceList; }
/**
* Get a pointer to the live device by its IP address. IP address can be both IPv4 or IPv6
* @param[in] ipAddr The IP address defined for the device
* @return A pointer to the live device if this IP address exists. NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByIp(const IPAddress& ipAddr) const;
/**
* Get a pointer to the live device by its IPv4 address
* @param[in] ipAddr The IPv4 address defined for the device
* @return A pointer to the live device if this IPv4 address exists. NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByIp(const IPv4Address& ipAddr) const;
/**
* Get a pointer to the live device by its IPv6 address
* @param[in] ip6Addr The IPv6 address defined for the device
* @return A pointer to the live device if this IPv6 address exists. NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByIp(const IPv6Address& ip6Addr) const;
/**
* Get a pointer to the live device by its IP address represented as string. IP address can be both IPv4 or IPv6
* @param[in] ipAddrAsString The IP address defined for the device as string
* @return A pointer to the live device if this IP address is valid and exists. NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByIp(const std::string& ipAddrAsString) const;
/**
* Get a pointer to the live device by its name
* @param[in] name The name of the interface (e.g eth0)
* @return A pointer to the live device if this name exists. NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByName(const std::string& name) const;
/**
* Get a pointer to the live device by its IP address or name
* @param[in] ipOrName An IP address or name of the interface
* @return A pointer to the live device if exists, NULL otherwise
*/
PcapLiveDevice* getPcapLiveDeviceByIpOrName(const std::string& ipOrName) const;
/**
* @return A list of all DNS servers defined for this machine. If this list is empty it means no DNS servers were defined or they
* couldn't be extracted from some reason
*/
const std::vector<IPv4Address>& getDnsServers() const { return m_DnsServers; }
/**
* Copies the current live device list
* @return A pointer to the cloned device list
*/
PcapLiveDeviceList* clone();
/**
* Reset the live device list and DNS server list, meaning clear and refetch them
*/
void reset();
// d'tor
~PcapLiveDeviceList();
};
} // namespace pcpp
#endif