PcapRemoteDeviceList.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
#include "IpAddress.h"
#include "DeviceListBase.h"
#include "PcapRemoteDevice.h"
#include "DeprecationUtils.h"
 
 
namespace pcpp
{
    class PcapRemoteDeviceList : public internal::DeviceListBase<PcapRemoteDevice>
    {
    private:
        using Base = internal::DeviceListBase<PcapRemoteDevice>;
 
        IPAddress m_RemoteMachineIpAddress;
        uint16_t m_RemoteMachinePort;
        std::shared_ptr<PcapRemoteAuthentication> m_RemoteAuthentication;
 
        // private c'tor. User should create the list via static methods PcapRemoteDeviceList::createRemoteDeviceList()
        PcapRemoteDeviceList(const IPAddress& ipAddress, uint16_t port,
                             std::shared_ptr<PcapRemoteAuthentication> remoteAuth,
                             PointerVector<PcapRemoteDevice> deviceList);
 
    public:
        using RemoteDeviceListIterator = iterator;
 
        using ConstRemoteDeviceListIterator = const_iterator;
 
        PcapRemoteDeviceList(const PcapRemoteDeviceList&) = delete;
        PcapRemoteDeviceList(PcapRemoteDeviceList&&) noexcept = delete;
        PcapRemoteDeviceList& operator=(const PcapRemoteDeviceList&) = delete;
        PcapRemoteDeviceList& operator=(PcapRemoteDeviceList&&) noexcept = delete;
 
        PCPP_DEPRECATED("Please use 'createRemoteDeviceList' factory method instead.")
        static PcapRemoteDeviceList* getRemoteDeviceList(const IPAddress& ipAddress, uint16_t port);
 
        static std::unique_ptr<PcapRemoteDeviceList> createRemoteDeviceList(const IPAddress& ipAddress, uint16_t port);
 
        PCPP_DEPRECATED("Please use 'createRemoteDeviceList' factory method instead.")
        static PcapRemoteDeviceList* getRemoteDeviceList(const IPAddress& ipAddress, uint16_t port,
                                                         PcapRemoteAuthentication* remoteAuth);
 
        static std::unique_ptr<PcapRemoteDeviceList> createRemoteDeviceList(const IPAddress& ipAddress, uint16_t port,
                                                                            PcapRemoteAuthentication const* remoteAuth);
 
        IPAddress getRemoteMachineIpAddress() const
        {
            return m_RemoteMachineIpAddress;
        }
 
        uint16_t getRemoteMachinePort() const
        {
            return m_RemoteMachinePort;
        }
 
        PCPP_DEPRECATED("Use `getDeviceByIp`")
        PcapRemoteDevice* getRemoteDeviceByIP(const IPv4Address& ip4Addr) const;
 
        PcapRemoteDevice* getDeviceByIP(const IPv4Address& ip4Addr) const;
 
        PCPP_DEPRECATED("Use `getDeviceByIp`")
        PcapRemoteDevice* getRemoteDeviceByIP(const IPv6Address& ip6Addr) const;
 
        PcapRemoteDevice* getDeviceByIP(const IPv6Address& ip6Addr) const;
 
        PCPP_DEPRECATED("Use `getDeviceByIp`")
        PcapRemoteDevice* getRemoteDeviceByIP(const IPAddress& ipAddr) const;
 
        PcapRemoteDevice* getDeviceByIP(const IPAddress& ipAddr) const;
 
        PCPP_DEPRECATED("Use `getDeviceByIp`")
        PcapRemoteDevice* getRemoteDeviceByIP(const std::string& ipAddrAsString) const;
 
        PcapRemoteDevice* getDeviceByIP(const std::string& ipAddrAsString) const;
    };
}  // namespace pcpp