Consolidate shared DeviceList functionality under a common base class.

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
-skip = *.dat,typos-config.toml,.git,.venv,./ci,./Dist,./mk,./Tests/ExamplesTest/expected_output,./Tests/ExamplesTest/pcap_examples,./Tests/Packet++Test/PacketExamples,./Tests/Pcap++Test/PcapExamples,./3rdParty,./Examples/PcapSearch/dirent-for-Visual-Studio
+skip = *.dat,typos-config.toml,.git,.venv,venv,./out,./ci,./Dist,./mk,./Tests/ExamplesTest/expected_output,./Tests/ExamplesTest/pcap_examples,./Tests/Packet++Test/PacketExamples,./Tests/Pcap++Test/PcapExamples,./3rdParty,./Examples/PcapSearch/dirent-for-Visual-Studio
 ignore-words = codespell-ignore-list.txt
 count =

Common++/header/DeprecationUtils.h

@@ -2,11 +2,27 @@
 
 /// @file
 
+#ifndef PCPP_DEPRECATED_GNU
+#	if defined(__GUNC__) || defined(__clang__)
+#		define PCPP_DEPRECATED_GNU(msg) __attribute__((deprecated(msg)))
+#	else
+#		define PCPP_DEPRECATED_GNU(msg)
+#	endif  // defined(__GUNC__) || defined(__clang__)
+#endif      // !PCPP_DEPRECATED_GNU
+
+#ifndef PCPP_DEPRECATED_MSVC
+#	ifdef _MSC_VER
+#		define PCPP_DEPRECATED_MSVC(msg) __declspec(deprecated(msg))
+#	else
+#		define PCPP_DEPRECATED_MSVC(msg)
+#	endif  // __MSC_VER
+#endif      // !PCPP_DEPRECATED_MSVC
+
 #ifndef PCPP_DEPRECATED
 #	if defined(__GNUC__) || defined(__clang__)
-#		define PCPP_DEPRECATED(msg) __attribute__((deprecated(msg)))
+#		define PCPP_DEPRECATED(msg) PCPP_DEPRECATED_GNU(msg)
 #	elif defined(_MSC_VER)
-#		define PCPP_DEPRECATED(msg) __declspec(deprecated(msg))
+#		define PCPP_DEPRECATED(msg) PCPP_DEPRECATED_MSVC(msg)
 #	else
 #		pragma message("WARNING: DEPRECATED feature is not implemented for this compiler")
 #		define PCPP_DEPRECATED(msg)

Common++/header/PointerVector.h

@@ -54,9 +54,10 @@ namespace pcpp
 	 * removed from the vector This class wraps std::vector and adds the capability of freeing objects once they're
 	 * removed from it
 	 */
-	template <typename T> class PointerVector
+	template <typename T, typename Deleter = std::default_delete<T>> class PointerVector
 	{
 	public:
+		using deleter_type = Deleter;
 		/**
 		 * Iterator object that is used for iterating all elements in the vector
 		 */
@@ -108,8 +109,11 @@ namespace pcpp
 		 */
 		PointerVector& operator=(const PointerVector& other)
 		{
-			// Saves a copy of the old pointer to defer cleanup.
-			auto oldValues = m_Vector;
+			if (this == &other)
+				return *this;
+
+			// Moves the old values to a temporary to defer cleanup.
+			auto oldValues = std::move(m_Vector);
 			try
 			{
 				m_Vector = deepCopyUnsafe(other.m_Vector);
@@ -133,6 +137,9 @@ namespace pcpp
 		 */
 		PointerVector& operator=(PointerVector&& other) noexcept
 		{
+			if (this == &other)
+				return *this;
+
 			// Releases all current elements.
 			clear();
 			// Moves the elements of the other vector.
@@ -177,7 +184,7 @@ namespace pcpp
 			{
 				if (freeElementOnError)
 				{
-					delete element;
+					Deleter()(element);
 				}
 				throw;
 			}
@@ -288,7 +295,7 @@ namespace pcpp
 		 */
 		VectorIterator erase(VectorIterator position)
 		{
-			delete (*position);
+			Deleter()(*position);
 			return m_Vector.erase(position);
 		}
 
@@ -386,10 +393,7 @@ namespace pcpp
 			}
 			catch (const std::exception&)
 			{
-				for (auto obj : copyVec)
-				{
-					delete obj;
-				}
+				freeVectorUnsafe(copyVec);
 				throw;
 			}
 
@@ -406,7 +410,7 @@ namespace pcpp
 		{
 			for (auto& obj : origin)
 			{
-				delete obj;
+				Deleter()(obj);
 			}
 		}
 

Examples/ArpSpoofing/main.cpp

@@ -237,7 +237,7 @@ int main(int argc, char* argv[])
 		EXIT_WITH_ERROR("Gateway address is not valid");
 	}
 
-	pcpp::PcapLiveDevice* pIfaceDevice = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIp(ifaceAddr);
+	pcpp::PcapLiveDevice* pIfaceDevice = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIp(ifaceAddr);
 
 	// Verifying interface is valid
 	if (pIfaceDevice == nullptr)

Examples/Arping/main.cpp

@@ -84,8 +84,7 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+	const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 	for (const auto& dev : devList)
@@ -198,7 +197,7 @@ int main(int argc, char* argv[])
 	// Search interface by name or IP
 	if (!ifaceNameOrIP.empty())
 	{
-		dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(ifaceNameOrIP);
+		dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(ifaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 	}

Examples/DNSResolver/main.cpp

@@ -75,11 +75,8 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
-
 	std::cout << std::endl << "Network interfaces:" << std::endl;
-	for (const auto& dev : devList)
+	for (const auto& dev : pcpp::PcapLiveDeviceList::getInstance())
 	{
 		std::cout << "    -> Name: '" << dev->getName() << "'   IP address: " << dev->getIPv4Address().toString()
 		          << std::endl;
@@ -182,15 +179,14 @@ int main(int argc, char* argv[])
 	// if interface name or IP was provided - find the device accordingly
 	if (interfaceNameOrIPProvided)
 	{
-		dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+		dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 	}
 	// if interface name or IP was not provided - find a device that has a default gateway
 	else
 	{
-		const std::vector<pcpp::PcapLiveDevice*>& devList =
-		    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+		const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 		auto iter = std::find_if(devList.begin(), devList.end(), [](pcpp::PcapLiveDevice* dev) {
 			return dev->getDefaultGateway() != pcpp::IPv4Address::Zero;

Examples/DnsSpoofing/main.cpp

@@ -127,8 +127,7 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+	const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 	for (const auto& dev : devList)
@@ -450,7 +449,7 @@ int main(int argc, char* argv[])
 		EXIT_WITH_ERROR("Interface name or IP weren't provided. Please use the -i switch or -h for help");
 	}
 
-	dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+	dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 

Examples/HttpAnalyzer/main.cpp

@@ -123,11 +123,8 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& liveDevices =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
-
 	std::cout << std::endl << "Network interfaces:" << std::endl;
-	for (const auto& device : liveDevices)
+	for (const auto& device : pcpp::PcapLiveDeviceList::getInstance())
 	{
 		std::cout << "    -> Name: '" << device->getName() << "'   IP address: " << device->getIPv4Address().toString()
 		          << std::endl;
@@ -569,8 +566,7 @@ int main(int argc, char* argv[])
 	}
 	else  // analyze in live traffic mode
 	{
-		pcpp::PcapLiveDevice* dev =
-		    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+		pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 

Examples/IcmpFileTransfer/Common.cpp

@@ -88,8 +88,7 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+	const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 	for (const auto& dev : devList)
@@ -174,7 +173,7 @@ void readCommandLineArguments(int argc, char* argv[], const std::string& thisSid
 	}
 	catch (const std::exception&)
 	{
-		pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByName(interfaceNameOrIP);
+		pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByName(interfaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR_PRINT_USAGE("Cannot find interface by provided name");
 

Examples/IcmpFileTransfer/IcmpFileTransfer-catcher.cpp

@@ -203,7 +203,7 @@ static bool getFileContent(pcpp::RawPacket* rawPacket, pcpp::PcapLiveDevice* dev
 void receiveFile(pcpp::IPv4Address pitcherIP, pcpp::IPv4Address catcherIP)
 {
 	// identify the interface to listen and send packets to
-	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIp(catcherIP);
+	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIp(catcherIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Cannot find network interface with IP '" << catcherIP << "'");
 
@@ -416,7 +416,7 @@ static bool sendContent(pcpp::RawPacket* rawPacket, pcpp::PcapLiveDevice* dev, v
 void sendFile(const std::string& filePath, pcpp::IPv4Address pitcherIP, pcpp::IPv4Address catcherIP, size_t blockSize)
 {
 	// identify the interface to listen and send packets to
-	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIp(catcherIP);
+	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIp(catcherIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Cannot find network interface with IP '" << catcherIP << "'");
 

Examples/IcmpFileTransfer/IcmpFileTransfer-pitcher.cpp

@@ -221,7 +221,7 @@ static void getFileContent(pcpp::RawPacket* rawPacket, pcpp::PcapLiveDevice* dev
 void receiveFile(pcpp::IPv4Address pitcherIP, pcpp::IPv4Address catcherIP, int packetPerSec)
 {
 	// identify the interface to listen and send packets to
-	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIp(pitcherIP);
+	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIp(pitcherIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Cannot find network interface with IP '" << pitcherIP << "'");
 
@@ -404,7 +404,7 @@ void sendFile(const std::string& filePath, pcpp::IPv4Address pitcherIP, pcpp::IP
               int packetPerSec)
 {
 	// identify the interface to listen and send packets to
-	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIp(pitcherIP);
+	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIp(pitcherIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Cannot find network interface with IP '" << pitcherIP << "'");
 

Examples/PfRingExample-FilterTraffic/main.cpp

@@ -141,7 +141,7 @@ void listPfRingDevices()
 	// suppress errors as there may be devices (like lo) that their MAC address can't be read, etc.
 	pcpp::Logger::getInstance().suppressLogs();
 
-	const std::vector<pcpp::PfRingDevice*>& devList = pcpp::PfRingDeviceList::getInstance().getPfRingDevicesList();
+	const auto& devList = pcpp::PfRingDeviceList::getInstance();
 	for (const auto& dev : devList)
 	{
 		std::ostringstream interfaceIndex;
@@ -277,15 +277,15 @@ int main(int argc, char* argv[])
 		case 'n':
 		{
 			std::string ifaceName = std::string(optarg);
-			dev = pcpp::PfRingDeviceList::getInstance().getPfRingDeviceByName(ifaceName);
+			dev = pcpp::PfRingDeviceList::getInstance().getDeviceByName(ifaceName);
 			if (dev == nullptr)
 				EXIT_WITH_ERROR("Could not find PF_RING device '" << ifaceName << "'");
 			break;
 		}
 		case 's':
 		{
 			std::string sendPacketsToIfaceName = std::string(optarg);
-			sendPacketsToIface = pcpp::PfRingDeviceList::getInstance().getPfRingDeviceByName(sendPacketsToIfaceName);
+			sendPacketsToIface = pcpp::PfRingDeviceList::getInstance().getDeviceByName(sendPacketsToIfaceName);
 			if (sendPacketsToIface == nullptr)
 				EXIT_WITH_ERROR("Could not find PF_RING device '" << sendPacketsToIfaceName << "'");
 

Examples/SSLAnalyzer/main.cpp

@@ -119,8 +119,7 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+	const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 	for (const auto& dev : devList)
@@ -531,8 +530,7 @@ int main(int argc, char* argv[])
 	else  // analyze in live traffic mode
 	{
 		// extract pcap live device by interface name or IP address
-		pcpp::PcapLiveDevice* dev =
-		    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+		pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 

Examples/TLSFingerprinting/main.cpp

@@ -141,8 +141,7 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	const std::vector<pcpp::PcapLiveDevice*>& devList =
-	    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
+	const auto& devList = pcpp::PcapLiveDeviceList::getInstance();
 
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 	for (const auto& dev : devList)
@@ -462,7 +461,7 @@ void doTlsFingerprintingOnLiveTraffic(const std::string& interfaceNameOrIP, std:
                                       const std::string& separator, bool chFP, bool shFP, const std::string& bpfFilter)
 {
 	// extract pcap live device by interface name or IP address
-	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+	pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 	if (dev == nullptr)
 		EXIT_WITH_ERROR("Couldn't find interface by given IP address or name");
 

Examples/TcpReassembly/main.cpp

@@ -329,11 +329,9 @@ void printAppVersion()
  */
 void listInterfaces()
 {
-	auto const& devList = pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList();
-
 	std::cout << std::endl << "Network interfaces:" << std::endl;
 
-	for (auto dev : devList)
+	for (auto dev : pcpp::PcapLiveDeviceList::getInstance())
 	{
 		std::cout << "    -> Name: '" << dev->getName() << "'   IP address: " << dev->getIPv4Address().toString()
 		          << std::endl;
@@ -689,8 +687,7 @@ int main(int argc, char* argv[])
 	else  // analyze in live traffic mode
 	{
 		// extract pcap live device by interface name or IP address
-		pcpp::PcapLiveDevice* dev =
-		    pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDeviceByIpOrName(interfaceNameOrIP);
+		pcpp::PcapLiveDevice* dev = pcpp::PcapLiveDeviceList::getInstance().getDeviceByIpOrName(interfaceNameOrIP);
 		if (dev == nullptr)
 			EXIT_WITH_ERROR("Couldn't find interface by provided IP address or name");
 

Examples/XdpExample-FilterTraffic/main.cpp

@@ -356,7 +356,7 @@ void printAppVersion()
 void listInterfaces()
 {
 	std::cout << std::endl << "Network interfaces:" << std::endl;
-	for (const auto& device : pcpp::PcapLiveDeviceList::getInstance().getPcapLiveDevicesList())
+	for (const auto& device : pcpp::PcapLiveDeviceList::getInstance())
 	{
 		if (device->getIPv4Address() != pcpp::IPv4Address::Zero)
 		{

Pcap++/CMakeLists.txt

@@ -26,6 +26,7 @@ add_library(
 
 set(public_headers
     header/Device.h
+    header/DeviceListBase.h
     header/NetworkUtils.h
     header/PcapDevice.h
     header/PcapFileDevice.h