SocketAddrInfo.cpp

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025, 2026
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#include "net/in/SocketAddrInfo.h"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include "log/Logger.h"
 
#include <cstring>
#include <netinet/in.h>
#include <sstream>
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
namespace net::in {
 
    SocketAddrInfo::~SocketAddrInfo() {
        if (addrInfo != nullptr) {
            freeaddrinfo(addrInfo);
        }
    }
 
    int SocketAddrInfo::resolve(const std::string& node, const std::string& service, const addrinfo& hints) {
        if (addrInfo != nullptr) {
            freeaddrinfo(addrInfo);
            addrInfo = nullptr;
        }
 
        int aiErrCode = 0;
 
        if ((aiErrCode = core::system::getaddrinfo(node.c_str(), service.c_str(), &hints, &addrInfo)) == 0) {
            currentAddrInfo = addrInfo;
        }
 
        return aiErrCode;
    }
 
    bool SocketAddrInfo::useNext() {
        // Lookup for a AddrInfo holding a ai_next AddrInfo which differ from the current one.
        // Especially localhost on IPv4 can lead to more than one entries representing the same SockAddr.
        // Thus, do not use this further SockAddr.
        while (currentAddrInfo != nullptr && currentAddrInfo->ai_next != nullptr &&
               std::memcmp(currentAddrInfo->ai_addr, currentAddrInfo->ai_next->ai_addr, sizeof(sockaddr_in)) == 0) {
            currentAddrInfo = currentAddrInfo->ai_next;
        }
 
        if (currentAddrInfo != nullptr) {
            currentAddrInfo = currentAddrInfo->ai_next;
        }
 
        return currentAddrInfo != nullptr;
    }
 
    sockaddr_in SocketAddrInfo::getSockAddr() {
        return currentAddrInfo != nullptr ? *reinterpret_cast<sockaddr_in*>(currentAddrInfo->ai_addr) // cppcheck-suppress internalAstError
                                          : sockaddr_in{.sin_family = AF_INET, .sin_port{}, .sin_addr{}, .sin_zero{}};
    }
 
    std::string SocketAddrInfo::getCanonName() {
        return currentAddrInfo->ai_canonname != nullptr ? currentAddrInfo->ai_canonname : std::string{};
    }
 
    void SocketAddrInfo::logAddressInfo() {
        if (currentAddrInfo != nullptr) {
            static char hostBfr[NI_MAXHOST];
            static char servBfr[NI_MAXSERV];
            std::memset(hostBfr, 0, NI_MAXHOST);
            std::memset(servBfr, 0, NI_MAXSERV);
 
            getnameinfo(currentAddrInfo->ai_addr,
                        currentAddrInfo->ai_addrlen,
                        hostBfr,
                        sizeof(hostBfr),
                        servBfr,
                        sizeof(servBfr),
                        NI_NUMERICHOST | NI_NUMERICSERV);
 
            const struct sockaddr_in* aiAddr = reinterpret_cast<sockaddr_in*>(currentAddrInfo->ai_addr);
 
            std::ostringstream formatted;
            formatted << "AddressInfo:\n"
                      << "   ai_next      = " << currentAddrInfo->ai_next << "\n"
                      << "   ai_flags     = " << currentAddrInfo->ai_flags << "\n"
                      << "   ai_family    = " << currentAddrInfo->ai_family << " (PF_INET = " << PF_INET << ", PF_INET6 = " << PF_INET6
                      << ")\n"
                      << "   ai_socktype  = " << currentAddrInfo->ai_socktype << " (SOCK_STREAM = " << SOCK_STREAM
                      << ", SOCK_DGRAM = " << SOCK_DGRAM << ")\n"
                      << "   ai_protocol  = " << currentAddrInfo->ai_protocol << " (IPPROTO_TCP = " << IPPROTO_TCP
                      << ", IPPROTO_UDP = " << IPPROTO_UDP << ")\n"
                      << "   ai_addrlen   = " << currentAddrInfo->ai_addrlen << " (sockaddr_in = " << sizeof(struct sockaddr_in)
                      << ", sockaddr_in6 = " << sizeof(struct sockaddr_in6) << ")\n"
                      << "   ai_addr      = sin_family:   " << aiAddr->sin_family << " (AF_INET = " << AF_INET
                      << ", AF_INET6 = " << AF_INET6 << ")\n"
                      << "                  sin_addr:     " << hostBfr << "\n"
                      << "                  sin_port:     " << servBfr;
 
            LOG(TRACE) << formatted.str();
        }
    }
 
} // namespace net::in