net::config::ConfigInstance Class Reference

#include <ConfigInstance.h>

Inheritance diagram for net::config::ConfigInstance:

Collaboration diagram for net::config::ConfigInstance:

Public Types
enum class	Role { SERVER , CLIENT }
using	Instance = ConfigInstance

Public Member Functions
	ConfigInstance (ConfigInstance &)=delete
	ConfigInstance (ConfigInstance &&)=delete
ConfigInstance &	operator= (ConfigInstance &)=delete
ConfigInstance &	operator= (ConfigInstance &&)=delete
Role	getRole ()
const std::string &	getInstanceName () const
void	setInstanceName (const std::string &instanceName)
bool	getDisabled () const
void	setDisabled (bool disabled=true)
CLI::App *	addSection (const std::string &name, const std::string &description, const std::string &group="Sections")
CLI::App *	getSection (const std::string &name, bool onlyGot=false, bool recursive=false) const
bool	gotSection (const std::string &name, bool recursive=false) const
void	required (CLI::App *section, bool req=true)
bool	getRequired () const

Protected Member Functions
	ConfigInstance (const std::string &instanceName, Role role)
virtual	~ConfigInstance ()

Private Attributes
uint8_t	requiredCount = 0
std::string	instanceName
Role	role
CLI::App *	instanceSc = nullptr
CLI::Option *	disableOpt = nullptr

Static Private Attributes
static const std::string	nameAnonymous = "<anonymous>"

Friends
class	net::config::ConfigSection

Detailed Description

Definition at line 63 of file ConfigInstance.h.

Member Typedef Documentation

Instance

using net::config::ConfigInstance::Instance = ConfigInstance

Definition at line 65 of file ConfigInstance.h.

Member Enumeration Documentation

Role

enum class net::config::ConfigInstance::Role

strong

Enumerator
SERVER
CLIENT

Definition at line 67 of file ConfigInstance.h.

{ SERVER, CLIENT };

Constructor & Destructor Documentation

ConfigInstance() [1/3]

net::config::ConfigInstance::ConfigInstance ( const std::string &  instanceName, Role  role  )

explicitprotected

Definition at line 75 of file ConfigInstance.cpp.

        : instanceName(instanceName)
        , role(role) {
        instanceSc = utils::Config::addInstance(instanceName,
                                                std::string("Configuration for ")
                                                    .append(role == Role::SERVER ? "server" : "client")
                                                    .append(" instance '")
                                                    .append(instanceName)
                                                    .append("'"),
                                                "Instances");
 
        disableOpt = instanceSc
                         ->add_flag_function(
                             "--disabled{true}",
                             [this](std::size_t) {
                                 utils::Config::disabled(instanceSc, disableOpt->as<bool>());
                             },
                             "Disable this instance")
                         ->multi_option_policy(CLI::MultiOptionPolicy::TakeLast)
                         ->trigger_on_parse()
                         ->default_str("false")
                         ->type_name("bool")
                         ->check(CLI::IsMember({"true", "false"}))
                         ->group(instanceSc->get_formatter()->get_label("Persistent Options"));
    }

References disableOpt, instanceName, instanceSc, role, and SERVER.

~ConfigInstance()

net::config::ConfigInstance::~ConfigInstance ( )

protectedvirtual

Definition at line 101 of file ConfigInstance.cpp.

                                    {
        utils::Config::removeInstance(instanceSc);
    }

References instanceSc.

ConfigInstance() [2/3]

net::config::ConfigInstance::ConfigInstance ( ConfigInstance &  )

delete

ConfigInstance() [3/3]

net::config::ConfigInstance::ConfigInstance ( ConfigInstance &&  )

delete

Member Function Documentation

addSection()

CLI::App * net::config::ConfigInstance::addSection	(	const std::string &	name,
		const std::string &	description,
		const std::string &	group = "Sections"
	)

Definition at line 117 of file ConfigInstance.cpp.

                                                                                                                  {
        CLI::App* sectionSc = instanceSc //
                                  ->add_subcommand(name, description)
                                  ->fallthrough()
                                  ->configurable(false)
                                  ->allow_extras(false)
                                  ->group(group)
                                  ->ignore_case(false)
                                  ->disabled(this->instanceName.empty() || name.empty());
 
        sectionSc //
            ->option_defaults()
            ->configurable(!sectionSc->get_disabled());
 
        if (!sectionSc->get_disabled()) {
            utils::Config::addStandardFlags(sectionSc);
            utils::Config::addSimpleHelp(sectionSc);
        }
 
        return sectionSc;
    }

References instanceName, and instanceSc.

Referenced by net::config::ConfigSection::ConfigSection().

Here is the caller graph for this function:

getDisabled()

bool net::config::ConfigInstance::getDisabled

(

)

const

Definition at line 184 of file ConfigInstance.cpp.

                                           {
        return disableOpt //
            ->as<bool>();
    }

References disableOpt.

Referenced by required().

Here is the caller graph for this function:

getInstanceName()

const std::string & net::config::ConfigInstance::getInstanceName

(

)

const

Definition at line 109 of file ConfigInstance.cpp.

                                                           {
        return instanceName.empty() ? nameAnonymous : instanceName;
    }

References instanceName, and nameAnonymous.

Referenced by net::config::ConfigSection::addOption(), net::un::config::ConfigAddress< ConfigAddressTypeT >::ConfigAddress(), net::config::ConfigSection::ConfigSection(), tls::getClient(), legacy::getLegacyClient(), net::config::stream::tls::ConfigSocketServer< ConfigSocketServerBaseT >::getSniCtx(), net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::getSslCtx(), net::config::stream::tls::ConfigSocketServer< ConfigSocketServerBaseT >::getSslCtx(), main(), and core::socket::stream::SocketConnection::SocketConnection().

Here is the caller graph for this function:

getRequired()

bool net::config::ConfigInstance::getRequired

(

)

const

Definition at line 162 of file ConfigInstance.cpp.

                                           {
        return requiredCount > 0;
    }

References requiredCount.

getRole()

ConfigInstance::Role net::config::ConfigInstance::getRole

(

)

Definition at line 105 of file ConfigInstance.cpp.

                                               {
        return role;
    }

References role.

getSection()

CLI::App * net::config::ConfigInstance::getSection	(	const std::string &	name,
		bool	onlyGot = false,
		bool	recursive = false
	)		const

Definition at line 166 of file ConfigInstance.cpp.

                                                                                                {
        CLI::App* resultSc = (instanceSc->got_subcommand(name) || !onlyGot) ? instanceSc->get_subcommand_no_throw(name) : nullptr;
 
        if (resultSc == nullptr && recursive) {
            CLI::App* parentSc = instanceSc->get_parent();
            resultSc =
                (parentSc != nullptr && (parentSc->got_subcommand(name) || !onlyGot)) ? parentSc->get_subcommand_no_throw(name) : nullptr;
        }
 
        return resultSc;
    }

References instanceSc.

Referenced by net::config::ConfigSection::ConfigSection().

Here is the caller graph for this function:

gotSection()

bool net::config::ConfigInstance::gotSection	(	const std::string &	name,
		bool	recursive = false
	)		const

Definition at line 178 of file ConfigInstance.cpp.

                                                                               {
        return instanceSc //
                   ->got_subcommand(name) ||
               (recursive && instanceSc->get_parent()->got_subcommand(name));
    }

References instanceSc.

operator=() [1/2]

ConfigInstance & net::config::ConfigInstance::operator= ( ConfigInstance &&  )

delete

operator=() [2/2]

ConfigInstance & net::config::ConfigInstance::operator= ( ConfigInstance &  )

delete

required()

void net::config::ConfigInstance::required	(	CLI::App *	section,
		bool	req = true
	)

Definition at line 139 of file ConfigInstance.cpp.

                                                           {
        if (req != section->get_required()) {
            if (req) {
                ++requiredCount;
                instanceSc //
                    ->needs(section);
            } else {
                --requiredCount;
                instanceSc //
                    ->remove_needs(section);
            }
 
            section //
                ->required(req);
            section //
                ->ignore_case(req);
 
            if (!getDisabled()) {
                utils::Config::required(instanceSc, requiredCount > 0);
            }
        }
    }

References getDisabled(), instanceSc, and requiredCount.

Referenced by net::config::ConfigSection::required().

Here is the call graph for this function:

Here is the caller graph for this function:

setDisabled()

void net::config::ConfigInstance::setDisabled

(

bool

disabled = true

)

Definition at line 189 of file ConfigInstance.cpp.

                                                  {
        disableOpt //
            ->default_str(disabled ? "true" : "false")
            ->clear();
 
        utils::Config::disabled(instanceSc, disabled);
    }

References disableOpt, and instanceSc.

setInstanceName()

void net::config::ConfigInstance::setInstanceName

(

const std::string &

instanceName

)

Definition at line 113 of file ConfigInstance.cpp.

                                                                      {
        this->instanceName = instanceName;
    }

References instanceName.

Friends And Related Symbol Documentation

net::config::ConfigSection

friend class net::config::ConfigSection

friend

Definition at line 107 of file ConfigInstance.h.

Member Data Documentation

disableOpt

CLI::Option* net::config::ConfigInstance::disableOpt = nullptr

private

Definition at line 105 of file ConfigInstance.h.

Referenced by ConfigInstance(), getDisabled(), and setDisabled().

instanceName

std::string net::config::ConfigInstance::instanceName

private

Definition at line 99 of file ConfigInstance.h.

Referenced by addSection(), ConfigInstance(), getInstanceName(), and setInstanceName().

instanceSc

CLI::App* net::config::ConfigInstance::instanceSc = nullptr

private

Definition at line 104 of file ConfigInstance.h.

Referenced by addSection(), ConfigInstance(), getSection(), gotSection(), required(), setDisabled(), and ~ConfigInstance().

nameAnonymous

const std::string net::config::ConfigInstance::nameAnonymous = "<anonymous>"

staticprivate

Definition at line 100 of file ConfigInstance.h.

Referenced by getInstanceName().

requiredCount

uint8_t net::config::ConfigInstance::requiredCount = 0

private

Definition at line 97 of file ConfigInstance.h.

Referenced by getRequired(), and required().

role

Role net::config::ConfigInstance::role

private

Definition at line 102 of file ConfigInstance.h.

Referenced by ConfigInstance(), and getRole().

---

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

• net/config/ConfigInstance.h
• net/config/ConfigInstance.cpp