SNode.C
Loading...
Searching...
No Matches
net::config::ConfigPhysicalSocketClient Class Reference

#include <ConfigPhysicalSocketClient.h>

Inheritance diagram for net::config::ConfigPhysicalSocketClient:
Collaboration diagram for net::config::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 () const
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
template<typename ConcretConfigPhysicalSocket>
 ConfigPhysicalSocket (ConfigInstance *instance, ConcretConfigPhysicalSocket *section)
Public Member Functions inherited from net::config::ConfigSection
template<typename T>
 ConfigSection (ConfigInstance *instance, T *sectionPtr, const std::string &group="Sections")
 ~ConfigSection () override
 ConfigSection (const ConfigSection &)=delete
 ConfigSection (ConfigSection &&)=delete
ConfigSection & operator= (const ConfigSection &)=delete
Public Member Functions inherited from utils::SubCommand
 SubCommand (const SubCommand &)=delete
 SubCommand (SubCommand &&)=delete
SubCommand & operator= (const SubCommand &)=delete
SubCommand & operator= (SubCommand &&)=delete
virtual ~SubCommand ()
std::string getName () const
std::string version () const
void parse (int argc, char *argv[])
CLI::Option * setConfig (const std::string &defaultConfigFile) const
CLI::Option * setLogFile (const std::string &defaultLogFile) const
CLI::Option * setVersionFlag (const std::string &version) const
bool hasParent () const
SubCommand * getParent ()
SubCommand * allowExtras (bool allow=true)
SubCommand * required (bool required=true, bool force=true)
SubCommand * required (SubCommand *subCommand, bool required=true)
SubCommand * required (CLI::Option *option, bool required=true)
SubCommand * needs (SubCommand *subCommand, bool needs=true)
SubCommand * disabled (SubCommand *subCommand, bool disabled=true)
SubCommand * setRequireCallback (const std::function< void(void)> &callback)
SubCommand * finalCallback (const std::function< void()> &finalCallback)
std::string configToStr () const
std::string help (const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
template<typename NewSubCommand, typename... Args>
NewSubCommand * newSubCommand (Args &&... args)
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand ()
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand () const
CLI::Option * getOption (const std::string &name) const
CLI::Option * addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator) const
template<typename ValueTypeT>
CLI::Option * addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator) const
CLI::Option * addOptionFunction (const std::string &name, std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOptionFunction (const std::string &name, std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option * addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option * addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator)
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)

Protected Member Functions

 ConfigPhysicalSocketClient (ConfigInstance *instance)
 ~ConfigPhysicalSocketClient () override
Protected Member Functions inherited from net::config::ConfigPhysicalSocket
template<typename ConcretConfigPhysicalSocketT>
 ConfigPhysicalSocket (ConfigInstance *instance, ConcretConfigPhysicalSocketT *section)
 ~ConfigPhysicalSocket () override
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 utils::SubCommand
 SubCommand (SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final)
template<typename ConcretSubCommand>
 SubCommand (SubCommand *parent, ConcretSubCommand *concretSubCommand, const std::string &group, bool final=true)
SubCommand * description (const std::string &description)
SubCommand * footer (const std::string &footer)
template<typename ValueTypeT>
CLI::Option * setDefaultValue (CLI::Option *option, const ValueTypeT &value, bool clear=true) const
CLI::Option * setConfigurable (CLI::Option *option, bool configurable) const

Private Types

using Super = ConfigPhysicalSocket

Private Attributes

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

Additional Inherited Members

Static Public Member Functions inherited from utils::SubCommand
static CLI::App * getHelpTriggerApp ()
static CLI::App * getShowConfigTriggerApp ()
static CLI::App * getCommandlineTriggerApp ()
Static Public Attributes inherited from net::config::ConfigPhysicalSocket
static constexpr std::string_view NAME {"socket"}
static constexpr std::string_view DESCRIPTION {"Configuration of socket behavior"}
Static Public Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter > sectionFormatter = makeSectionFormatter()
Static Protected Attributes inherited from utils::SubCommand
static std::map< std::string, std::string > aliases
static CLI::App * helpTriggerApp = nullptr
static CLI::App * showConfigTriggerApp = nullptr
static CLI::App * commandlineTriggerApp = nullptr

Detailed Description

Definition at line 60 of file ConfigPhysicalSocketClient.h.

Member Typedef Documentation

◆ Super

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

Definition at line 62 of file ConfigPhysicalSocketClient.h.

Constructor & Destructor Documentation

◆ ConfigPhysicalSocketClient()

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

Definition at line 59 of file ConfigPhysicalSocketClient.cpp.

60 : ConfigPhysicalSocket(instance, this) {
61 reconnectOpt = addFlagFunction( //
62 "--reconnect{true}",
63 [this]() {
64 if (!this->reconnectOpt->as<bool>()) {
65 this->reconnectTimeOpt->clear();
66 }
67 },
68 "Auto-reconnection in the event of a connection interruption",
69 "bool",
70 XSTR(RECONNECT),
71 CLI::IsMember({"true", "false"}));
72
73 reconnectTimeOpt = addOption( //
74 "--reconnect-time",
75 "Duration after disconnect before reconnect",
76 "sec",
77 RECONNECT_TIME,
78 CLI::NonNegativeNumber);
79 reconnectTimeOpt->needs(reconnectOpt);
80
81 connectTimeoutOpt = addOption( //
82 "--connect-timeout",
83 "Connect timeout",
84 "timeout",
85 CONNECT_TIMEOUT,
86 CLI::NonNegativeNumber);
87 }
XSTR
#define XSTR(s)
Definition ConfigPhysicalSocket.cpp:53
net::config::ConfigPhysicalSocket::ConfigPhysicalSocket
ConfigPhysicalSocket(ConfigInstance *instance, ConcretConfigPhysicalSocketT *section)
utils::SubCommand::addFlagFunction
CLI::Option * addFlagFunction(const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator)
Definition SubCommand.cpp:407
utils::SubCommand::addOption
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
Definition SubCommand.cpp:373

References utils::SubCommand::addFlagFunction(), net::config::ConfigPhysicalSocket::ConfigPhysicalSocket(), connectTimeoutOpt, reconnectOpt, and reconnectTimeOpt.

Here is the call graph for this function:

◆ ~ConfigPhysicalSocketClient()

net::config::ConfigPhysicalSocketClient::~ConfigPhysicalSocketClient ( )
overrideprotected

Definition at line 89 of file ConfigPhysicalSocketClient.cpp.

89 {
90 }

Member Function Documentation

◆ getConnectTimeout()

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

Definition at line 124 of file ConfigPhysicalSocketClient.cpp.

124 {
125 return utils::Timeval(connectTimeoutOpt->as<double>());
126 }

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

Here is the call graph for this function:

◆ getReconnect()

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

Definition at line 104 of file ConfigPhysicalSocketClient.cpp.

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

References reconnectOpt.

◆ getReconnectTime()

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

Definition at line 114 of file ConfigPhysicalSocketClient.cpp.

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

References reconnectTimeOpt.

◆ setConnectTimeout()

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

Definition at line 118 of file ConfigPhysicalSocketClient.cpp.

118 {
119 setDefaultValue(connectTimeoutOpt, connectTimeout);
120
121 return *this;
122 }
utils::SubCommand::setDefaultValue
CLI::Option * setDefaultValue(CLI::Option *option, const ValueTypeT &value, bool clear=true) const
Definition SubCommand.h:337

References connectTimeoutOpt, and utils::SubCommand::setDefaultValue().

Here is the call graph for this function:

◆ setReconnect()

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

Definition at line 92 of file ConfigPhysicalSocketClient.cpp.

92 {
93 setDefaultValue(reconnectOpt, reconnect ? "true" : "false");
94
95 if (reconnect) {
96 reconnectTimeOpt->remove_needs(reconnectOpt);
97 } else {
98 reconnectTimeOpt->needs(reconnectOpt);
99 }
100
101 return *this;
102 }

References reconnectOpt, reconnectTimeOpt, and utils::SubCommand::setDefaultValue().

Here is the call graph for this function:

◆ setReconnectTime()

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

Definition at line 108 of file ConfigPhysicalSocketClient.cpp.

108 {
109 setDefaultValue(reconnectTimeOpt, time);
110
111 return *this;
112 }

References reconnectTimeOpt, and utils::SubCommand::setDefaultValue().

Here is the call graph for this function:

Member Data Documentation

◆ connectTimeoutOpt

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

Definition at line 83 of file ConfigPhysicalSocketClient.h.

Referenced by ConfigPhysicalSocketClient(), getConnectTimeout(), and setConnectTimeout().

◆ reconnectOpt

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

Definition at line 80 of file ConfigPhysicalSocketClient.h.

Referenced by ConfigPhysicalSocketClient(), getReconnect(), and setReconnect().

◆ reconnectTimeOpt

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

Definition at line 81 of file ConfigPhysicalSocketClient.h.

Referenced by ConfigPhysicalSocketClient(), getReconnectTime(), setReconnect(), and setReconnectTime().

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