#include <ConfigPhysicalSocketClient.h>

Inheritance diagram for net::config::ConfigPhysicalSocketClient:

Collaboration diagram for net::config::ConfigPhysicalSocketClient:

Public Types
using	Socket = ConfigPhysicalSocketClient

Public Member Functions
ConfigPhysicalSocketClient &	setReconnect (bool reconnect=true)
bool	getReconnect () const
ConfigPhysicalSocketClient &	setReconnectTime (double time)
double	getReconnectTime () const
ConfigPhysicalSocketClient &	setConnectTimeout (const utils::Timeval &connectTimeout)
utils::Timeval	getConnectTimeout () const
Public Member Functions inherited from net::config::ConfigPhysicalSocket
const std::map< int, std::map< int, 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
	ConfigPhysicalSocketClient (ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigPhysicalSocket
	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 Types
using	Super = ConfigPhysicalSocket

Private Attributes
CLI::Option *	reconnectOpt = nullptr
CLI::Option *	reconnectTimeOpt = nullptr
CLI::Option *	connectTimeoutOpt = nullptr

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

Detailed Description

Definition at line 62 of file ConfigPhysicalSocketClient.h.

Member Typedef Documentation

◆ Socket

using net::config::ConfigPhysicalSocketClient::Socket = ConfigPhysicalSocketClient

Definition at line 67 of file ConfigPhysicalSocketClient.h.

◆ Super

using net::config::ConfigPhysicalSocketClient::Super = ConfigPhysicalSocket

private

Definition at line 64 of file ConfigPhysicalSocketClient.h.

Constructor & Destructor Documentation

◆ ConfigPhysicalSocketClient()

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

explicitprotected

Definition at line 59 of file ConfigPhysicalSocketClient.cpp.

        : Super(instance) {
        reconnectOpt = addFlagFunction( //
            "--reconnect{true}",
            [this]() {
                if (!this->reconnectOpt->as<bool>()) {
                    this->reconnectTimeOpt->clear();
                }
            },
            "Auto-reconnection in the event of a connection interruption",
            "bool",
            XSTR(RECONNECT),
            CLI::IsMember({"true", "false"}));
 
        reconnectTimeOpt = addOption( //
            "--reconnect-time",
            "Duration after disconnect before reconnect",
            "sec",
            RECONNECT_TIME,
            CLI::NonNegativeNumber);
        reconnectTimeOpt->needs(reconnectOpt);
 
        connectTimeoutOpt = addOption( //
            "--connect-timeout",
            "Connect timeout",
            "timeout",
            CONNECT_TIMEOUT,
            CLI::NonNegativeNumber);
    }

References net::config::ConfigSection::addFlagFunction(), net::config::ConfigPhysicalSocket::ConfigPhysicalSocket(), reconnectOpt, and reconnectTimeOpt.

Here is the call graph for this function:

Member Function Documentation

◆ getConnectTimeout()

utils::Timeval net::config::ConfigPhysicalSocketClient::getConnectTimeout ( ) const

Definition at line 127 of file ConfigPhysicalSocketClient.cpp.

                                                                     {
        const double connectTimeout = connectTimeoutOpt->as<double>();
        return utils::Timeval(connectTimeout);
    }

References connectTimeoutOpt, and utils::Timeval::Timeval().

Here is the call graph for this function:

◆ getReconnect()

bool net::config::ConfigPhysicalSocketClient::getReconnect ( ) const

Definition at line 103 of file ConfigPhysicalSocketClient.cpp.

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

References reconnectOpt.

◆ getReconnectTime()

double net::config::ConfigPhysicalSocketClient::getReconnectTime ( ) const

Definition at line 115 of file ConfigPhysicalSocketClient.cpp.

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

References reconnectTimeOpt.

◆ setConnectTimeout()

ConfigPhysicalSocketClient & net::config::ConfigPhysicalSocketClient::setConnectTimeout ( const utils::Timeval & connectTimeout )

Definition at line 119 of file ConfigPhysicalSocketClient.cpp.

                                                                                                                {
        connectTimeoutOpt //
            ->default_val(connectTimeout)
            ->clear();
 
        return *this;
    }

References connectTimeoutOpt.

◆ setReconnect()

ConfigPhysicalSocketClient & net::config::ConfigPhysicalSocketClient::setReconnect ( bool reconnect = true )

Definition at line 89 of file ConfigPhysicalSocketClient.cpp.

                                                                                       {
        reconnectOpt //
            ->default_val(reconnect ? "true" : "false")
            ->clear();
 
        if (reconnect) {
            reconnectTimeOpt->remove_needs(reconnectOpt);
        } else {
            reconnectTimeOpt->needs(reconnectOpt);
        }
 
        return *this;
    }

References reconnectOpt, and reconnectTimeOpt.

◆ setReconnectTime()

ConfigPhysicalSocketClient & net::config::ConfigPhysicalSocketClient::setReconnectTime ( double time )

Definition at line 107 of file ConfigPhysicalSocketClient.cpp.

                                                                                        {
        reconnectTimeOpt //
            ->default_val(time)
            ->clear();
 
        return *this;
    }