ConfigSocketClient.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/stream/config/ConfigSocketClient.h"
 
#include "net/config/stream/ConfigSocketClient.hpp"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include "core/system/socket.h"
 
#include <netinet/in.h>
#include <netinet/tcp.h>
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
#define XSTR(s) STR(s)
#define STR(s) #s
 
namespace net::in::stream::config {
 
    ConfigSocketClient::ConfigSocketClient(net::config::ConfigInstance* instance)
        : net::config::stream::ConfigSocketClient<net::in::config::ConfigAddress>(instance) {
        Remote::setHostRequired();
        Remote::setPortRequired();
        Remote::setAiSockType(SOCK_STREAM);
        Remote::setAiProtocol(IPPROTO_TCP);
 
        Local::setAiSockType(SOCK_STREAM);
        Local::setAiProtocol(IPPROTO_TCP);
 
        disableNagleAlgorithmOpt = net::config::ConfigPhysicalSocket::addSocketOption( //
            "--disable-nagle-algorithm{true}",
            IPPROTO_TCP,
            TCP_NODELAY,
            "Turn of Nagle algorithm",
            "tristat",
            XSTR(IN_CLIENT_DISABLE_NAGLE_ALGORITHM),
            CLI::IsMember({"true", "false", "default"}));
        if (std::string(XSTR(IN6_SERVER_DISABLE_NAGLE_ALGORITHM)) == "default") {
            Local::setDefaultValue(disableNagleAlgorithmOpt, "false");
        }
    }
 
    ConfigSocketClient::~ConfigSocketClient() {
    }
 
    ConfigSocketClient& ConfigSocketClient::setDisableNagleAlgorithm(bool disableNagleAlgorithm) {
        if (disableNagleAlgorithm) {
            addSocketOption(IPPROTO_TCP, TCP_NODELAY, 1);
        } else {
            addSocketOption(IPPROTO_TCP, TCP_NODELAY, 0);
        }
 
        Local::setDefaultValue(disableNagleAlgorithmOpt, disableNagleAlgorithm ? "true" : "false");
 
        return *this;
    }
 
    bool ConfigSocketClient::getDisableNagleAlgorithm() const {
        bool disableNagleAlgorithm = false;
 
        try {
            disableNagleAlgorithm = disableNagleAlgorithmOpt->as<bool>();
        } catch (CLI::RuntimeError&) {
        }
 
        return disableNagleAlgorithm;
    }
 
} // namespace net::in::stream::config
 
template class net::config::stream::ConfigSocketClient<net::in::config::ConfigAddress>;