#include <ConfigConnection.h>

Inheritance diagram for net::config::ConfigConnection:

Collaboration diagram for net::config::ConfigConnection:

Public Member Functions
utils::Timeval	getReadTimeout () const
ConfigConnection &	setReadTimeout (const utils::Timeval &newReadTimeoutSet)
utils::Timeval	getWriteTimeout () const
ConfigConnection &	setWriteTimeout (const utils::Timeval &newWriteTimeoutSet)
std::size_t	getReadBlockSize () const
ConfigConnection &	setReadBlockSize (std::size_t newReadBlockSize)
std::size_t	getWriteBlockSize () const
ConfigConnection &	setWriteBlockSize (std::size_t newWriteBlockSize)
utils::Timeval	getTerminateTimeout () const
ConfigConnection &	setTerminateTimeout (const utils::Timeval &newTerminateTimeout)
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
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 () const
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)
bool	getRequired () const
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, const 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, const 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) const
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) const

Static Public Attributes
static constexpr std::string_view	NAME {"connection"}
static constexpr std::string_view	DESCRIPTION {"Configuration of established connections"}

Protected Member Functions
	ConfigConnection (ConfigInstance *instance)
	~ConfigConnection () override
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)
void	parse (int argc, char *argv[]) const
SubCommand *	description (const std::string &description)
SubCommand *	footer (const std::string &footer)
void	removeSubCommand ()
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 Attributes
CLI::Option *	readTimeoutOpt = nullptr
CLI::Option *	writeTimeoutOpt = nullptr
CLI::Option *	readBlockSizeOpt = nullptr
CLI::Option *	writeBlockSizeOpt = nullptr
CLI::Option *	terminateTimeoutOpt = nullptr

Additional Inherited Members
Static Protected Member Functions inherited from utils::SubCommand
static CLI::App *	getHelpTriggerApp ()
static CLI::App *	getShowConfigTriggerApp ()
static CLI::App *	getCommandlineTriggerApp ()
Static Protected Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter >	sectionFormatter = makeSectionFormatter()
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 61 of file ConfigConnection.h.

Constructor & Destructor Documentation

◆ ConfigConnection()

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

explicitprotected

Definition at line 52 of file ConfigConnection.cpp.

        : net::config::ConfigSection(instance, this) {
        readTimeoutOpt = addOption( //
            "--read-timeout",
            "Read timeout in seconds",
            "timeout",
            READ_TIMEOUT,
            CLI::PositiveNumber);
 
        writeTimeoutOpt = addOption( //
            "--write-timeout",
            "Write timeout in seconds",
            "timeout",
            WRITE_TIMEOUT,
            CLI::PositiveNumber);
 
        readBlockSizeOpt = addOption( //
            "--read-block-size",
            "Read block size",
            "size",
            READ_BLOCKSIZE,
            CLI::PositiveNumber);
 
        writeBlockSizeOpt = addOption( //
            "--write-block-size",
            "Write block size",
            "size",
            WRITE_BLOCKSIZE,
            CLI::PositiveNumber);
 
        terminateTimeoutOpt = addOption( //
            "--terminate-timeout",
            "Terminate timeout",
            "timeout",
            TERMINATE_TIMEOUT,
            CLI::PositiveNumber);
    }

References net::config::ConfigSection::ConfigSection(), readBlockSizeOpt, readTimeoutOpt, terminateTimeoutOpt, writeBlockSizeOpt, and writeTimeoutOpt.

Here is the call graph for this function:

◆ ~ConfigConnection()

net::config::ConfigConnection::~ConfigConnection ( )

overrideprotected

Definition at line 90 of file ConfigConnection.cpp.

90 {

91 }

Member Function Documentation

◆ getReadBlockSize()

std::size_t net::config::ConfigConnection::getReadBlockSize ( ) const

Definition at line 113 of file ConfigConnection.cpp.

                                                       {
        return readBlockSizeOpt->as<std::size_t>();
    }

References readBlockSizeOpt.

◆ getReadTimeout()

utils::Timeval net::config::ConfigConnection::getReadTimeout ( ) const

Definition at line 93 of file ConfigConnection.cpp.

                                                        {
        return readTimeoutOpt->as<utils::Timeval>();
    }

References readTimeoutOpt.

◆ getTerminateTimeout()

utils::Timeval net::config::ConfigConnection::getTerminateTimeout ( ) const

Definition at line 133 of file ConfigConnection.cpp.

                                                             {
        return terminateTimeoutOpt->as<utils::Timeval>();
    }

References terminateTimeoutOpt.

◆ getWriteBlockSize()

std::size_t net::config::ConfigConnection::getWriteBlockSize ( ) const

Definition at line 123 of file ConfigConnection.cpp.

                                                        {
        return writeBlockSizeOpt->as<std::size_t>();
    }

References writeBlockSizeOpt.

◆ getWriteTimeout()

utils::Timeval net::config::ConfigConnection::getWriteTimeout ( ) const

Definition at line 103 of file ConfigConnection.cpp.

                                                         {
        return writeTimeoutOpt->as<utils::Timeval>();
    }

References writeTimeoutOpt.

◆ setReadBlockSize()

ConfigConnection & net::config::ConfigConnection::setReadBlockSize ( std::size_t newReadBlockSize )

Definition at line 117 of file ConfigConnection.cpp.

                                                                                   {
        setDefaultValue(readBlockSizeOpt, newReadBlockSize);
 
        return *this;
    }

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

Here is the call graph for this function:

◆ setReadTimeout()

ConfigConnection & net::config::ConfigConnection::setReadTimeout ( const utils::Timeval & newReadTimeoutSet )

Definition at line 97 of file ConfigConnection.cpp.

                                                                                            {
        setDefaultValue(readTimeoutOpt, newReadTimeoutSet);
 
        return *this;
    }

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

Here is the call graph for this function:

◆ setTerminateTimeout()

ConfigConnection & net::config::ConfigConnection::setTerminateTimeout ( const utils::Timeval & newTerminateTimeout )

Definition at line 137 of file ConfigConnection.cpp.

                                                                                                   {
        setDefaultValue(terminateTimeoutOpt, newTerminateTimeout);
 
        return *this;
    }

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

Here is the call graph for this function:

◆ setWriteBlockSize()

ConfigConnection & net::config::ConfigConnection::setWriteBlockSize ( std::size_t newWriteBlockSize )

Definition at line 127 of file ConfigConnection.cpp.

                                                                                     {
        setDefaultValue(writeBlockSizeOpt, newWriteBlockSize);
 
        return *this;
    }

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

Here is the call graph for this function:

◆ setWriteTimeout()

ConfigConnection & net::config::ConfigConnection::setWriteTimeout ( const utils::Timeval & newWriteTimeoutSet )

Definition at line 107 of file ConfigConnection.cpp.

                                                                                              {
        setDefaultValue(writeTimeoutOpt, newWriteTimeoutSet);
 
        return *this;
    }

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

Here is the call graph for this function:

Member Data Documentation

◆ DESCRIPTION

std::string_view net::config::ConfigConnection::DESCRIPTION {"Configuration of established connections"}

staticconstexpr

Definition at line 64 of file ConfigConnection.h.

64{"Configuration of established connections"};

◆ NAME

std::string_view net::config::ConfigConnection::NAME {"connection"}

staticconstexpr

Definition at line 63 of file ConfigConnection.h.

63{"connection"};

◆ readBlockSizeOpt

CLI::Option* net::config::ConfigConnection::readBlockSizeOpt = nullptr

private

Definition at line 90 of file ConfigConnection.h.

Referenced by ConfigConnection(), getReadBlockSize(), and setReadBlockSize().

◆ readTimeoutOpt

CLI::Option* net::config::ConfigConnection::readTimeoutOpt = nullptr

private

Definition at line 88 of file ConfigConnection.h.

Referenced by ConfigConnection(), getReadTimeout(), and setReadTimeout().

◆ terminateTimeoutOpt

CLI::Option* net::config::ConfigConnection::terminateTimeoutOpt = nullptr

private

Definition at line 92 of file ConfigConnection.h.

Referenced by ConfigConnection(), getTerminateTimeout(), and setTerminateTimeout().

◆ writeBlockSizeOpt

CLI::Option* net::config::ConfigConnection::writeBlockSizeOpt = nullptr

private

Definition at line 91 of file ConfigConnection.h.

Referenced by ConfigConnection(), getWriteBlockSize(), and setWriteBlockSize().

◆ writeTimeoutOpt

CLI::Option* net::config::ConfigConnection::writeTimeoutOpt = nullptr

private

Definition at line 89 of file ConfigConnection.h.

Referenced by ConfigConnection(), getWriteTimeout(), and setWriteTimeout().

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

net/config/ConfigConnection.h
net/config/ConfigConnection.cpp

SNode.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConfigConnection()

◆ ~ConfigConnection()

Member Function Documentation

◆ getReadBlockSize()

◆ getReadTimeout()

◆ getTerminateTimeout()

◆ getWriteBlockSize()

◆ getWriteTimeout()

◆ setReadBlockSize()

◆ setReadTimeout()

◆ setTerminateTimeout()

◆ setWriteBlockSize()

◆ setWriteTimeout()

Member Data Documentation

◆ DESCRIPTION

◆ NAME

◆ readBlockSizeOpt

◆ readTimeoutOpt

◆ terminateTimeoutOpt

◆ writeBlockSizeOpt

◆ writeTimeoutOpt