#include <ConfigPhysicalSocket.h>

Inheritance diagram for net::config::ConfigPhysicalSocket:

Collaboration diagram for net::config::ConfigPhysicalSocket:

Public Member Functions
const std::map< int, std::map< int, const net::phy::PhysicalSocketOption > > &	getSocketOptions ()

ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, int optValue)

ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, const std::string &optValue)

ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, const std::vector< char > &optValue)

ConfigPhysicalSocket &	removeSocketOption (int optLevel, int optName)

ConfigPhysicalSocket &	setRetry (bool retry=true)

bool	getRetry () const

ConfigPhysicalSocket &	setRetryOnFatal (bool retry=true)

bool	getRetryOnFatal () const

ConfigPhysicalSocket &	setRetryTimeout (double sec)

double	getRetryTimeout () const

ConfigPhysicalSocket &	setRetryTries (unsigned int tries=0)

unsigned int	getRetryTries () const

ConfigPhysicalSocket &	setRetryBase (double base)

double	getRetryBase () const

ConfigPhysicalSocket &	setRetryLimit (unsigned int limit)

unsigned int	getRetryLimit () const

ConfigPhysicalSocket &	setRetryJitter (double percent)

double	getRetryJitter () const

Protected Member Functions
	ConfigPhysicalSocket (ConfigInstance *instance)

CLI::Option *	addSocketOption (const std::string &name, int optLevel, int optName, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator)

Protected Member Functions inherited from net::config::ConfigSection
	ConfigSection (ConfigInstance *instance, const std::string &name, const std::string &description)

	ConfigSection (const ConfigSection &)=delete

	ConfigSection (ConfigSection &&)=delete

ConfigSection &	operator= (const ConfigSection &)=delete

ConfigSection &	operator= (ConfigSection &&)=delete

CLI::Option *	addOption (const std::string &name, const std::string &description)

CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName)

CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)

template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)

template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)

CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName)

CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)

template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)

template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)

CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue)

CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator)

void	required (CLI::Option *opt, bool req=true)

bool	required () const

template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)

template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)

template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)

template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)

Private Attributes
CLI::Option *	retryOpt = nullptr

CLI::Option *	retryOnFatalOpt = nullptr

CLI::Option *	retryTriesOpt = nullptr

CLI::Option *	retryTimeoutOpt = nullptr

CLI::Option *	retryBaseOpt = nullptr

CLI::Option *	retryLimitOpt = nullptr

CLI::Option *	retryJitterOpt = nullptr

std::map< int, std::map< int, const net::phy::PhysicalSocketOption > >	socketOptionsMapMap

Additional Inherited Members
Protected Attributes inherited from net::config::ConfigSection
CLI::App *	section = nullptr

Detailed Description

Definition at line 66 of file ConfigPhysicalSocket.h.

Constructor & Destructor Documentation

◆ ConfigPhysicalSocket()

net::config::ConfigPhysicalSocket::ConfigPhysicalSocket ( ConfigInstance * instance )

explicitprotected

Definition at line 59 of file ConfigPhysicalSocket.cpp.

        : ConfigSection(instance, "socket", "Configuration of socket behavior") {
        retryOpt = addFlag( //
            "--retry{true}",
            "Automatically retry listen|connect",
            "bool",
            XSTR(RETRY),
            CLI::IsMember({"true", "false"}));
 
        retryOnFatalOpt = addFlagFunction( //
            "--retry-on-fatal{true}",
            [this]() {
                if (retryOnFatalOpt->as<bool>() && !retryOpt->as<bool>()) {
                    throw CLI::RequiresError(retryOnFatalOpt->get_name(), retryOpt->get_name().append("=true"));
                }
            },
            "Retry also on fatal errors",
            "bool",
            XSTR(RETRY_ON_FATAL),
            CLI::IsMember({"true", "false"}));
        retryOnFatalOpt->needs(retryOpt);
 
        retryTimeoutOpt = addOption( //
            "--retry-timeout",
            "Timeout of the retry timer",
            "sec",
            RETRY_TIMEOUT,
            CLI::NonNegativeNumber);
        retryTimeoutOpt->needs(retryOpt);
 
        retryTriesOpt = addOption( //
            "--retry-tries",
            "Number of retry attempts before giving up (0 = unlimited)",
            "tries",
            RETRY_TRIES,
            CLI::TypeValidator<unsigned int>());
        retryTriesOpt->needs(retryOpt);
 
        retryBaseOpt = addOption( //
            "--retry-base",
            "Base of exponential backoff",
            "base",
            RETRY_BASE,
            CLI::PositiveNumber);
        retryBaseOpt->needs(retryOpt);
 
        retryJitterOpt = addOption( //
            "--retry-jitter",
            "Maximum jitter in percent to apply randomly to calculated retry timeout (0 to disable)",
            "jitter",
            RETRY_JITTER,
            CLI::Range(0., 100.));
        retryJitterOpt->needs(retryOpt);
 
        retryLimitOpt = addOption( //
            "--retry-limit",
            "Upper limit in seconds of retry timeout (0 for infinite)",
            "sec",
            RETRY_LIMIT,
            CLI::NonNegativeNumber);
        retryLimitOpt->needs(retryOpt);
    }

References net::config::ConfigSection::addFlag(), net::config::ConfigSection::addFlagFunction(), net::config::ConfigSection::ConfigSection(), retryBaseOpt, retryJitterOpt, retryLimitOpt, retryOnFatalOpt, retryOpt, retryTimeoutOpt, and retryTriesOpt.

Referenced by net::config::ConfigPhysicalSocketClient::ConfigPhysicalSocketClient(), and net::config::ConfigPhysicalSocketServer::ConfigPhysicalSocketServer().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ addSocketOption() [1/4]

CLI::Option * net::config::ConfigPhysicalSocket::addSocketOption	(	const std::string &	name,
		int	optLevel,
		int	optName,
		const std::string &	description,
		const std::string &	typeName,
		const std::string &	defaultValue,
		const CLI::Validator &	validator
	)

protected

Definition at line 126 of file ConfigPhysicalSocket.cpp.

                                                                                      {
        return addFlagFunction(
                   name,
                   [this, strippedName = name.substr(0, name.find('{')), optLevel, optName]() {
                       try {
                           try {
                               if (section->get_option(strippedName)->as<bool>()) {
                                   socketOptionsMapMap[optLevel].emplace(optName, net::phy::PhysicalSocketOption(optLevel, optName, 1));
                               } else {
                                   socketOptionsMapMap[optLevel].emplace(optName, net::phy::PhysicalSocketOption(optLevel, optName, 0));
                               }
                           } catch ([[maybe_unused]] CLI::ConversionError& err) {
                               if (socketOptionsMapMap.contains(optLevel)) {
                                   socketOptionsMapMap[optLevel].erase(optName);
                                   if (socketOptionsMapMap[optLevel].empty()) {
                                       socketOptionsMapMap.erase(optLevel);
                                   }
                               }
                           }
                       } catch (CLI::OptionNotFound& err) {
                           LOG(ERROR) << err.what();
                       }
                   },
                   description,
                   typeName,
                   defaultValue,
                   validator)
            ->force_callback();
    }

References net::config::ConfigSection::addFlagFunction(), net::phy::PhysicalSocketOption::PhysicalSocketOption(), net::config::ConfigSection::section, and socketOptionsMapMap.

Referenced by net::in::stream::config::ConfigSocketClient::ConfigSocketClient(), net::in6::stream::config::ConfigSocketClient::ConfigSocketClient(), net::in::stream::config::ConfigSocketServer::ConfigSocketServer(), and net::in6::stream::config::ConfigSocketServer::ConfigSocketServer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSocketOption() [2/4]

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::addSocketOption	(	int	optLevel,
		int	optName,
		const std::string &	optValue
	)

Definition at line 168 of file ConfigPhysicalSocket.cpp.

                                                                                                                    {
        socketOptionsMapMap[optLevel].emplace(optName, net::phy::PhysicalSocketOption(optLevel, optName, optValue));
 
        return *this;
    }

References net::phy::PhysicalSocketOption::PhysicalSocketOption(), and socketOptionsMapMap.

Here is the call graph for this function:

◆ addSocketOption() [3/4]

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::addSocketOption	(	int	optLevel,
		int	optName,
		const std::vector< char > &	optValue
	)

Definition at line 174 of file ConfigPhysicalSocket.cpp.

                                                                                                                          {
        socketOptionsMapMap[optLevel].emplace(optName, net::phy::PhysicalSocketOption(optLevel, optName, optValue));
 
        return *this;
    }

References net::phy::PhysicalSocketOption::PhysicalSocketOption(), and socketOptionsMapMap.

Here is the call graph for this function:

◆ addSocketOption() [4/4]

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::addSocketOption	(	int	optLevel,
		int	optName,
		int	optValue
	)

Definition at line 162 of file ConfigPhysicalSocket.cpp.

                                                                                                       {
        socketOptionsMapMap[optLevel].emplace(optName, net::phy::PhysicalSocketOption(optLevel, optName, optValue));
 
        return *this;
    }

References net::phy::PhysicalSocketOption::PhysicalSocketOption(), and socketOptionsMapMap.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRetry()

bool net::config::ConfigPhysicalSocket::getRetry ( ) const

Definition at line 213 of file ConfigPhysicalSocket.cpp.

                                              {
        return retryOpt->as<bool>();
    }

References retryOpt.

◆ getRetryBase()

double net::config::ConfigPhysicalSocket::getRetryBase ( ) const

Definition at line 261 of file ConfigPhysicalSocket.cpp.

                                                    {
        return retryBaseOpt->as<double>();
    }

References retryBaseOpt.

◆ getRetryJitter()

double net::config::ConfigPhysicalSocket::getRetryJitter ( ) const

Definition at line 285 of file ConfigPhysicalSocket.cpp.

                                                      {
        return retryJitterOpt->as<double>();
    }

References retryJitterOpt.

◆ getRetryLimit()

unsigned int net::config::ConfigPhysicalSocket::getRetryLimit ( ) const

Definition at line 273 of file ConfigPhysicalSocket.cpp.

                                                           {
        return retryLimitOpt->as<unsigned int>();
    }

References retryLimitOpt.

◆ getRetryOnFatal()

bool net::config::ConfigPhysicalSocket::getRetryOnFatal ( ) const

Definition at line 225 of file ConfigPhysicalSocket.cpp.

                                                     {
        return retryOnFatalOpt->as<bool>();
    }

References retryOnFatalOpt.

◆ getRetryTimeout()

double net::config::ConfigPhysicalSocket::getRetryTimeout ( ) const

Definition at line 237 of file ConfigPhysicalSocket.cpp.

                                                       {
        return retryTimeoutOpt->as<double>();
    }

References retryTimeoutOpt.

◆ getRetryTries()

unsigned int net::config::ConfigPhysicalSocket::getRetryTries ( ) const

Definition at line 249 of file ConfigPhysicalSocket.cpp.

                                                           {
        return retryTriesOpt->as<unsigned int>();
    }

References retryTriesOpt.

◆ getSocketOptions()

const std::map< int, std::map< int, const net::phy::PhysicalSocketOption > > & net::config::ConfigPhysicalSocket::getSocketOptions ( )

Definition at line 122 of file ConfigPhysicalSocket.cpp.

                                                                                                             {
        return socketOptionsMapMap;
    }

References socketOptionsMapMap.

◆ removeSocketOption()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::removeSocketOption	(	int	optLevel,
		int	optName
	)

Definition at line 180 of file ConfigPhysicalSocket.cpp.

                                                                                                             {
        socketOptionsMapMap[optLevel].erase(optName);
        if (socketOptionsMapMap[optLevel].empty()) {
            socketOptionsMapMap.erase(optLevel);
        }
 
        return *this;
    }

References socketOptionsMapMap.

◆ setRetry()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetry ( bool retry = true )

Definition at line 189 of file ConfigPhysicalSocket.cpp.

                                                                   {
        retryOpt //
            ->default_val(retry ? "true" : "false")
            ->clear();
 
        if (retry) {
            retryLimitOpt->remove_needs(retryOpt);
            retryJitterOpt->remove_needs(retryOpt);
            retryBaseOpt->remove_needs(retryOpt);
            retryTriesOpt->remove_needs(retryOpt);
            retryTimeoutOpt->remove_needs(retryOpt);
            retryOnFatalOpt->remove_needs(retryOpt);
        } else {
            retryLimitOpt->needs(retryOpt);
            retryJitterOpt->needs(retryOpt);
            retryBaseOpt->needs(retryOpt);
            retryTriesOpt->needs(retryOpt);
            retryTimeoutOpt->needs(retryOpt);
            retryOnFatalOpt->needs(retryOpt);
        }
 
        return *this;
    }

References retryBaseOpt, retryJitterOpt, retryLimitOpt, retryOnFatalOpt, retryOpt, retryTimeoutOpt, and retryTriesOpt.

◆ setRetryBase()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryBase ( double base )

Definition at line 253 of file ConfigPhysicalSocket.cpp.

                                                                        {
        retryBaseOpt //
            ->default_val(base)
            ->clear();
 
        return *this;
    }

References retryBaseOpt.

◆ setRetryJitter()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryJitter ( double percent )

Definition at line 277 of file ConfigPhysicalSocket.cpp.

                                                                             {
        retryJitterOpt //
            ->default_val(percent)
            ->clear();
 
        return *this;
    }

References retryJitterOpt.

◆ setRetryLimit()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryLimit ( unsigned int limit )

Definition at line 265 of file ConfigPhysicalSocket.cpp.

                                                                                {
        retryLimitOpt //
            ->default_val(limit)
            ->clear();
 
        return *this;
    }

References retryLimitOpt.

◆ setRetryOnFatal()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryOnFatal ( bool retry = true )

Definition at line 217 of file ConfigPhysicalSocket.cpp.

                                                                          {
        retryOnFatalOpt //
            ->default_val(retry ? "true" : "false")
            ->clear();
 
        return *this;
    }

References retryOnFatalOpt.

◆ setRetryTimeout()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryTimeout ( double sec )

Definition at line 229 of file ConfigPhysicalSocket.cpp.

                                                                          {
        retryTimeoutOpt //
            ->default_val(sec)
            ->clear();
 
        return *this;
    }

References retryTimeoutOpt.

◆ setRetryTries()

ConfigPhysicalSocket & net::config::ConfigPhysicalSocket::setRetryTries ( unsigned int tries = 0 )

Definition at line 241 of file ConfigPhysicalSocket.cpp.

                                                                                {
        retryTriesOpt //
            ->default_val(tries)
            ->clear();
 
        return *this;
    }

References retryTriesOpt.

Member Data Documentation

◆ retryBaseOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryBaseOpt = nullptr

private

Definition at line 114 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryBase(), setRetry(), and setRetryBase().

◆ retryJitterOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryJitterOpt = nullptr

private

Definition at line 116 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryJitter(), setRetry(), and setRetryJitter().

◆ retryLimitOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryLimitOpt = nullptr

private

Definition at line 115 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryLimit(), setRetry(), and setRetryLimit().

◆ retryOnFatalOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryOnFatalOpt = nullptr

private

Definition at line 111 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryOnFatal(), setRetry(), and setRetryOnFatal().

◆ retryOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryOpt = nullptr

private

Definition at line 110 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetry(), and setRetry().

◆ retryTimeoutOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryTimeoutOpt = nullptr

private

Definition at line 113 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryTimeout(), setRetry(), and setRetryTimeout().

◆ retryTriesOpt

CLI::Option* net::config::ConfigPhysicalSocket::retryTriesOpt = nullptr

private

Definition at line 112 of file ConfigPhysicalSocket.h.

Referenced by ConfigPhysicalSocket(), getRetryTries(), setRetry(), and setRetryTries().

◆ socketOptionsMapMap

std::map<int, std::map<int, const net::phy::PhysicalSocketOption> > net::config::ConfigPhysicalSocket::socketOptionsMapMap

private

Definition at line 118 of file ConfigPhysicalSocket.h.

Referenced by addSocketOption(), addSocketOption(), addSocketOption(), addSocketOption(), getSocketOptions(), and removeSocketOption().

The documentation for this class was generated from the following files:

net/config/ConfigPhysicalSocket.h
net/config/ConfigPhysicalSocket.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConfigPhysicalSocket()

Member Function Documentation

◆ addSocketOption() [1/4]

◆ addSocketOption() [2/4]

◆ addSocketOption() [3/4]

◆ addSocketOption() [4/4]

◆ getRetry()

◆ getRetryBase()

◆ getRetryJitter()

◆ getRetryLimit()

◆ getRetryOnFatal()

◆ getRetryTimeout()

◆ getRetryTries()

◆ getSocketOptions()

◆ removeSocketOption()

◆ setRetry()

◆ setRetryBase()

◆ setRetryJitter()

◆ setRetryLimit()

◆ setRetryOnFatal()

◆ setRetryTimeout()

◆ setRetryTries()

Member Data Documentation

◆ retryBaseOpt

◆ retryJitterOpt

◆ retryLimitOpt

◆ retryOnFatalOpt

◆ retryOpt

◆ retryTimeoutOpt

◆ retryTriesOpt

◆ socketOptionsMapMap