netadapter.hpp

Go to the documentation of this file.

#ifndef UPnPsdk_NETADAPTER_HPP
#define UPnPsdk_NETADAPTER_HPP
// Copyright (C) 2024+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
// Redistribution only with this Copyright remark. Last modified: 2025-05-15
#include <UPnPsdk/netadapter_platform.hpp>
 
namespace UPnPsdk {
 
uint8_t netmask_to_bitmask(
    const ::sockaddr_storage* a_netmask);
 
 
void bitmask_to_netmask(
    const ::sockaddr_storage* a_saddr,
    const unsigned int a_prefixlength,
    SSockaddr& a_saddrObj);
 
 
class CNetadapter {
    // Due to warning C4251 "'type' : class 'type1' needs to have dll-interface
    // to be used by clients of class 'type2'" on Microsoft Windows each member
    // function needs to be decorated with UPnPsdk_API instead of just only the
    // class. The reason is 'm_na_platformPtr'.
  public:
    UPnPsdk_API CNetadapter(
        PNetadapter_platform a_na_platformPtr =
            std::make_shared<CNetadapter_platform>());
 
    /* \brief Destructor */
    UPnPsdk_API virtual ~CNetadapter();
 
    // Copy constructor
    // We cannot use the default copy constructor because there is also
    // allocated memory for the ifaddrs structure to copy. We get segfaults
    // and program aborts. This class is not usable to copy the object.
    CNetadapter(const CNetadapter&) = delete;
 
    // Copy assignment operator
    // Same as with the copy constructor.
    CNetadapter& operator=(CNetadapter) = delete;
 
    // methods from injected object
    UPnPsdk_API void get_first();
    UPnPsdk_API bool get_next();
    UPnPsdk_API unsigned int index() const;
    UPnPsdk_API std::string name() const;
    UPnPsdk_API void sockaddr(SSockaddr& a_saddr) const;
    UPnPsdk_API void socknetmask(SSockaddr& a_snetmask) const;
    UPnPsdk_API unsigned int bitmask() const;
 
    // Own methods
    UPnPsdk_API bool find_first(
        std::string_view a_name_or_addr = "");
 
    UPnPsdk_API bool find_first(
        const unsigned int a_index);
 
    UPnPsdk_API bool find_next();
 
  private:
    // Injected smart pointer to the netadapter object of the current operating
    // system. It may also point to a mocking object.
    PNetadapter_platform m_na_platformPtr;
 
    // State of the finding steps.
    enum struct Find { finish, best, loopback, index } m_state{};
 
    // Index of the first found network adapter.
    // Only used with m_state = Find::index;
    unsigned int m_find_index{};
 
    // Private helper methods.
    void reset() noexcept;
};
 
} // namespace UPnPsdk
 
#endif // UPnPsdk_NETADAPTER_HPP