sockaddr.hpp

Go to the documentation of this file.

#ifndef UPnPsdk_NET_SOCKADDR_HPP
#define UPnPsdk_NET_SOCKADDR_HPP
// Copyright (C) 2022+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
// Redistribution only with this Copyright remark. Last modified: 2026-02-22
#include <UPnPsdk/visibility.hpp>
#include <UPnPsdk/port.hpp>
#include <UPnPsdk/port_sock.hpp>
#ifdef _MSC_VER
#include <afunix.h>
#else
#include <sys/un.h>
#endif
 
#include <string>
 
namespace UPnPsdk {
 
union sockaddr_t {
    ::sockaddr_storage ss;
    ::sockaddr_un sun;
    ::sockaddr_in6 sin6;
    ::sockaddr_in sin;
    ::sockaddr sa;
};
 
 
int to_port( //
    std::string_view a_port_str,
    in_port_t* const a_port_num = nullptr) noexcept;
 
 
void split_addr_port( //
    std::string_view a_addr_str,
    std::string& a_addr,
    std::string& a_serv);
 
 
struct UPnPsdk_API SSockaddr {
    sockaddr_storage& ss = m_sa_union.ss;
    sockaddr_un& sun = m_sa_union.sun;
    sockaddr_in6& sin6 = m_sa_union.sin6;
    sockaddr_in& sin = m_sa_union.sin;
    sockaddr& sa = m_sa_union.sa;
 
    // Constructor
    // -----------
    SSockaddr();
 
    // Destructor
    // ----------
    virtual ~SSockaddr();
 
    // Get reference to the sockaddr_storage structure.
    // Only as example, I don't use it because it may be confusing. I only use
    // SSockaddr::ss (instantiated e.g. ssObj.ss) to access the trivial
    // member structure.
    // operator const ::sockaddr_storage&() const;
 
    // Copy constructor
    SSockaddr(const SSockaddr&);
 
 
    // Copy assignment operator
    // Strong exception guarantee with value argument as given.
    SSockaddr& operator=(SSockaddr); // value argument
 
 
    // Assignment operator to set a netaddress
    // ---------------------------------------
    void operator=(
        std::string_view a_addr_str); // noexept?
 
 
    // Assignment operator= to set socket port from an integer
    // -------------------------------------------------------
    void operator=(const in_port_t a_port);
 
 
    // Assignment operator= to set socket address from a trivial socket address
    // structure
    // ------------------------------------------------------------------------
    void operator=(const ::sockaddr_storage& a_ss);
 
 
    // Compare operator
    // ----------------
    bool operator==(const SSockaddr&) const;
 
 
    // Getter for a netaddress
    // -----------------------
    const std::string netaddr() noexcept;
 
 
    // Getter for a netaddress with port
    // ---------------------------------
    const std::string netaddrp() noexcept;
 
 
    // ----------------------------
    in_port_t port() const;
 
 
    // ----------------------------------------------------------------------
    socklen_t sizeof_saddr() const;
 
 
    // -------------------------------------------------------
    bool is_loopback() const;
 
 
  private:
    sockaddr_t m_sa_union{}; // this is the union of trivial sockaddr structures
                             // that is managed.
};
 
 
// Getter of the netaddress to output stream
// -----------------------------------------
UPnPsdk_API ::std::ostream& operator<<(::std::ostream& os, SSockaddr& saddr);
 
} // namespace UPnPsdk
 
#endif // UPnPsdk_NET_SOCKADDR_HPP