#include <ConfigConnection.h>

Inheritance diagram for net::config::ConfigConnection:

Collaboration diagram for net::config::ConfigConnection:

Public Types
using	Connection = 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)

Protected Member Functions
	ConfigConnection (ConfigInstance *instance)

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 *	readTimeoutOpt = nullptr

CLI::Option *	writeTimeoutOpt = nullptr

CLI::Option *	readBlockSizeOpt = nullptr

CLI::Option *	writeBlockSizeOpt = nullptr

CLI::Option *	terminateTimeoutOpt = nullptr

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

Detailed Description

Definition at line 42 of file ConfigConnection.h.

Member Typedef Documentation

◆ Connection

using net::config::ConfigConnection::Connection = ConfigConnection

Definition at line 44 of file ConfigConnection.h.

Constructor & Destructor Documentation

◆ ConfigConnection()

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

explicitprotected

Definition at line 30 of file ConfigConnection.cpp.

        : net::config::ConfigSection(instance, "connection", "Configuration of established connections") {
        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);
    }

Member Function Documentation

◆ getReadBlockSize()

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

Definition at line 92 of file ConfigConnection.cpp.

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

◆ getReadTimeout()

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

Definition at line 68 of file ConfigConnection.cpp.

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

◆ getTerminateTimeout()

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

Definition at line 116 of file ConfigConnection.cpp.

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

◆ getWriteBlockSize()

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

Definition at line 104 of file ConfigConnection.cpp.

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

◆ getWriteTimeout()

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

Definition at line 80 of file ConfigConnection.cpp.

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

◆ setReadBlockSize()

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

Definition at line 96 of file ConfigConnection.cpp.

                                                                                   {
        readBlockSizeOpt //
            ->default_val(newReadBlockSize)
            ->clear();
 
        return *this;
    }

◆ setReadTimeout()

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

Definition at line 72 of file ConfigConnection.cpp.

                                                                                            {
        readTimeoutOpt //
            ->default_val(newReadTimeoutSet)
            ->clear();
 
        return *this;
    }

◆ setTerminateTimeout()

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

Definition at line 120 of file ConfigConnection.cpp.

                                                                                                   {
        terminateTimeoutOpt //
            ->default_val(newTerminateTimeout)
            ->clear();
 
        return *this;
    }

◆ setWriteBlockSize()

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

Definition at line 108 of file ConfigConnection.cpp.

                                                                                     {
        writeBlockSizeOpt //
            ->default_val(newWriteBlockSize)
            ->clear();
 
        return *this;
    }

◆ setWriteTimeout()

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

Definition at line 84 of file ConfigConnection.cpp.

                                                                                              {
        writeTimeoutOpt //
            ->default_val(newWriteTimeoutSet)
            ->clear();
 
        return *this;
    }

Member Data Documentation

◆ readBlockSizeOpt

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

private

Definition at line 68 of file ConfigConnection.h.

◆ readTimeoutOpt

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

private

Definition at line 66 of file ConfigConnection.h.

◆ terminateTimeoutOpt

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

private

Definition at line 70 of file ConfigConnection.h.

◆ writeBlockSizeOpt

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

private

Definition at line 69 of file ConfigConnection.h.

◆ writeTimeoutOpt

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

private

Definition at line 67 of file ConfigConnection.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Connection

Constructor & Destructor Documentation

◆ ConfigConnection()

Member Function Documentation

◆ getReadBlockSize()

◆ getReadTimeout()

◆ getTerminateTimeout()

◆ getWriteBlockSize()

◆ getWriteTimeout()

◆ setReadBlockSize()

◆ setReadTimeout()

◆ setTerminateTimeout()

◆ setWriteBlockSize()

◆ setWriteTimeout()

Member Data Documentation

◆ readBlockSizeOpt

◆ readTimeoutOpt

◆ terminateTimeoutOpt

◆ writeBlockSizeOpt

◆ writeTimeoutOpt