Change PcapLiveDevice to store IP information as IPAddresses. #1497
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…uct DeviceInterfaceDetails to allow direct construction of the device without re-fetching from the Pcap layer.
… of the correct type.
2 tasks
Dimi1010
changed the title
2 tasks
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #1497 +/- ##
==========================================
+ Coverage 80.05% 83.23% +3.17%
==========================================
Files 276 276
Lines 42074 46883 +4809
Branches 9339 9407 +68
==========================================
+ Hits 33684 39021 +5337
- Misses 6664 7008 +344
+ Partials 1726 854 -872
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
# Conflicts: # Pcap++/header/PcapDevice.h # Pcap++/header/WinPcapLiveDevice.h # Pcap++/src/PcapLiveDevice.cpp # Pcap++/src/PcapRemoteDevice.cpp # Pcap++/src/PcapRemoteDeviceList.cpp
Dimi1010
added
the
breaking change
seladb
approved these changes
Oct 11, 2024
Comment on lines
+83
to
+96
| /// @struct DeviceInterfaceDetails | ||
| /// @brief A struct that contains all details of a network interface. | ||
| struct DeviceInterfaceDetails | ||
| { | ||
| explicit DeviceInterfaceDetails(pcap_if_t* pInterface); | ||
| /// @brief Name of the device. | ||
| std::string name; | ||
| /// @brief Description of the device. | ||
| std::string description; | ||
| /// @brief IP addresses associated with the device. | ||
| std::vector<IPAddress> addresses; | ||
| /// @brief Flag to indicate if the device is a loopback device. | ||
| bool isLoopback; | ||
| }; |
There was a problem hiding this comment.
very nit: no need for doxygen documentation for private/protected structs
There was a problem hiding this comment.
Sure, its not strictly required, but I think its fine to stay, right?
| @@ -91,8 +91,13 @@ namespace pcpp | |||
| std::shared_ptr<PcapRemoteAuthentication> m_RemoteAuthentication; | |||
|
|
|||
| // c'tor is private, as only PcapRemoteDeviceList should create instances of it, and it'll create only one for | |||
| // every remote interface | |||
There was a problem hiding this comment.
huh, good catch. did not mean that to be removed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1439 and #1499.
This IP changes the internal structure of
PcapLiveDeviceto hold the IP information inIPAddressclasses instead ofpcap_addrstructs. This fixes the issues where IP information might be randomly overwritten. Additionally the clean separation between the device information and the device proper allows cleaner clone procedure where the cached device information can be used to instantiate anotherDeviceobject. The reworked procedure also fixes the clone issues withPcapRemoteDevice.PcapLiveDevicechangesA new protected structure
DeviceInformationDetailshas been added toPcapLiveDeviceto hold the relatively static information about the device (name, description, addresses). The previously separate device members are replaced by a single member structure that is now used to hold that information.NB: The change removes the previously deprecated method
getAddresses()and should NOT be merged before its deprecation cycle is completeIn addition to the changes a new constructor overload has been added to
PcapLiveDeviceand derived classes taking the abovementioned structure instead ofpcap_if_tpointer, allowing device construction from cached information.Optimizing the clone procedure
During the clone procedure, the
m_InterfaceDetailsstructure is used to inject the current device's parameters to the clone's constructor without the need to re-fetch and search through the entire device list from the Pcap layer. Theclonemethod is updated to a virtual method and performs the construction of a new device object directly without re-fetching the devices.The method
cloneInternalhas been removed as superfluous, and derived implementations have been updated to override theclonemethod instead.Fix for clone of
PcapRemoteDevice.clonetoPcapRemoteDeviceto instantiate a new remote device from the current one's interface details.PcapRemoteDevice::clonemethod returns a non-nullPcapLiveDevicepointer that can be successfully downcasted to aPcapRemoteDevicepointer.