mqtt::mqttstore::lib::ConfigDatabase Class Reference

#include <ConfigSections.h>

Inheritance diagram for mqtt::mqttstore::lib::ConfigDatabase:

Collaboration diagram for mqtt::mqttstore::lib::ConfigDatabase:

Public Member Functions
	ConfigDatabase (utils::SubCommand *parent)
	~ConfigDatabase () override
std::string	getHost () const
std::string	getUsername () const
std::string	getPassword () const
std::string	getDatabase () const
std::uint16_t	getPort () const
std::string	getSocket () const
std::uint32_t	getFlags () const

Static Public Attributes
static constexpr std::string_view	NAME {"db"}
static constexpr std::string_view	DESCRIPTION {"MariaDB/MySQL connection"}

Private Attributes
CLI::Option *	hostOpt
CLI::Option *	usernameOpt
CLI::Option *	passwordOpt
CLI::Option *	databaseOpt
CLI::Option *	portOpt
CLI::Option *	socketOpt
CLI::Option *	flagsOpt

Detailed Description

Definition at line 75 of file ConfigSections.h.

Constructor & Destructor Documentation

ConfigDatabase()

mqtt::mqttstore::lib::ConfigDatabase::ConfigDatabase

(

utils::SubCommand *

parent

)

Definition at line 110 of file ConfigSections.cpp.

        : utils::SubCommand(parent, this, "Database connection")
        , hostOpt(setConfigurable(
              addOption("--host", "Hostname or IP address of MariaDB server", "hostname|IPv4", CLI::TypeValidator<std::string>()), true))
        , usernameOpt(setConfigurable(addOption("--username", "Database username", "string", CLI::TypeValidator<std::string>()), true))
        , passwordOpt(setConfigurable(addOption("--password", "Database password", "string", CLI::TypeValidator<std::string>()), true))
        , databaseOpt(setConfigurable(addOption("--database", "Database name", "string", CLI::TypeValidator<std::string>()), true))
        , portOpt(setConfigurable(addOption("--port", "Database TCP port", "uint16_t", 3306, CLI::TypeValidator<std::uint16_t>()), true))
        , socketOpt(setConfigurable(addOption("--socket",
                                              "Database socket file (overrides host and port when set)",
                                              "string",
                                              "/run/mysqld/mysqld.sock",
                                              CLI::TypeValidator<std::string>()),
                                    true))
        , flagsOpt(setConfigurable(addOption("--flags", "MariaDB connection flags", "uint32_t", "0", CLI::TypeValidator<std::uint32_t>()),
                                   true)) {
    }

References databaseOpt, flagsOpt, hostOpt, passwordOpt, portOpt, socketOpt, and usernameOpt.

~ConfigDatabase()

mqtt::mqttstore::lib::ConfigDatabase::~ConfigDatabase ( )

overridedefault

Member Function Documentation

getDatabase()

std::string mqtt::mqttstore::lib::ConfigDatabase::getDatabase ( ) const

nodiscard

Definition at line 142 of file ConfigSections.cpp.

                                                {
        return databaseOpt->as<std::string>();
    }

References databaseOpt.

getFlags()

std::uint32_t mqtt::mqttstore::lib::ConfigDatabase::getFlags ( ) const

nodiscard

Definition at line 154 of file ConfigSections.cpp.

                                               {
        return flagsOpt->as<std::uint32_t>();
    }

References flagsOpt.

getHost()

std::string mqtt::mqttstore::lib::ConfigDatabase::getHost ( ) const

nodiscard

Definition at line 130 of file ConfigSections.cpp.

                                            {
        return hostOpt->as<std::string>();
    }

References hostOpt.

getPassword()

std::string mqtt::mqttstore::lib::ConfigDatabase::getPassword ( ) const

nodiscard

Definition at line 138 of file ConfigSections.cpp.

                                                {
        return passwordOpt->as<std::string>();
    }

References passwordOpt.

getPort()

std::uint16_t mqtt::mqttstore::lib::ConfigDatabase::getPort ( ) const

nodiscard

Definition at line 146 of file ConfigSections.cpp.

                                              {
        return portOpt->as<std::uint16_t>();
    }

References portOpt.

getSocket()

std::string mqtt::mqttstore::lib::ConfigDatabase::getSocket ( ) const

nodiscard

Definition at line 150 of file ConfigSections.cpp.

                                              {
        return socketOpt->as<std::string>();
    }

References socketOpt.

getUsername()

std::string mqtt::mqttstore::lib::ConfigDatabase::getUsername ( ) const

nodiscard

Definition at line 134 of file ConfigSections.cpp.

                                                {
        return usernameOpt->as<std::string>();
    }

References usernameOpt.

Member Data Documentation

databaseOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::databaseOpt

private

Definition at line 95 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getDatabase().

DESCRIPTION

std::string_view mqtt::mqttstore::lib::ConfigDatabase::DESCRIPTION {"MariaDB/MySQL connection"}

staticconstexpr

Definition at line 78 of file ConfigSections.h.

{"MariaDB/MySQL connection"};

flagsOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::flagsOpt

private

Definition at line 98 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getFlags().

hostOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::hostOpt

private

Definition at line 92 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getHost().

NAME

std::string_view mqtt::mqttstore::lib::ConfigDatabase::NAME {"db"}

staticconstexpr

Definition at line 77 of file ConfigSections.h.

{"db"};

passwordOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::passwordOpt

private

Definition at line 94 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getPassword().

portOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::portOpt

private

Definition at line 96 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getPort().

socketOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::socketOpt

private

Definition at line 97 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getSocket().

usernameOpt

CLI::Option* mqtt::mqttstore::lib::ConfigDatabase::usernameOpt

private

Definition at line 93 of file ConfigSections.h.

Referenced by ConfigDatabase(), and getUsername().

---

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

• mqttstore/lib/ConfigSections.h
• mqttstore/lib/ConfigSections.cpp