#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, 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
	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);
    }

Member Function Documentation

◆ getConnectTimeout()

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

Definition at line 127 of file ConfigPhysicalSocketClient.cpp.

127 {

128 const double connectTimeout = connectTimeoutOpt->as<double>();

129 return utils::Timeval(connectTimeout);

130 }

utils::Timeval

Definition Timeval.h:58

◆ getReconnect()

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

Definition at line 103 of file ConfigPhysicalSocketClient.cpp.

103 {

104 return reconnectOpt->as<bool>();

105 }

◆ getReconnectTime()

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

Definition at line 115 of file ConfigPhysicalSocketClient.cpp.

115 {

116 return reconnectTimeOpt->as<double>();

117 }

◆ 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;
    }

◆ 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;
    }

◆ setReconnectTime()

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

Definition at line 107 of file ConfigPhysicalSocketClient.cpp.

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

Member Data Documentation

◆ connectTimeoutOpt

CLI::Option* net::config::ConfigPhysicalSocketClient::connectTimeoutOpt = nullptr

private

Definition at line 86 of file ConfigPhysicalSocketClient.h.

◆ reconnectOpt

CLI::Option* net::config::ConfigPhysicalSocketClient::reconnectOpt = nullptr

private

Definition at line 83 of file ConfigPhysicalSocketClient.h.

◆ reconnectTimeOpt

CLI::Option* net::config::ConfigPhysicalSocketClient::reconnectTimeOpt = nullptr

private

Definition at line 84 of file ConfigPhysicalSocketClient.h.

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

net/config/ConfigPhysicalSocketClient.h
net/config/ConfigPhysicalSocketClient.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Socket

◆ Super

Constructor & Destructor Documentation

◆ ConfigPhysicalSocketClient()

Member Function Documentation

◆ getConnectTimeout()

◆ getReconnect()

◆ getReconnectTime()

◆ setConnectTimeout()

◆ setReconnect()

◆ setReconnectTime()

Member Data Documentation

◆ connectTimeoutOpt

◆ reconnectOpt

◆ reconnectTimeOpt