#include <ConfigSections.h>

Inheritance diagram for mqtt::mqttcli::lib::ConfigSession:

Collaboration diagram for mqtt::mqttcli::lib::ConfigSession:

Public Member Functions
	ConfigSession (utils::SubCommand *parent)
	~ConfigSession () override
std::string	getClientId () const
const ConfigSession &	setClientId (const std::string &clientId) const
uint8_t	getQoS () const
const ConfigSession &	setQos (uint8_t qoS) const
bool	getRetainSession () const
const ConfigSession &	setRetainSession (bool retainSession) const
uint16_t	getKeepAlive () const
const ConfigSession &	setKeepAlive (uint16_t keepAlive) const
std::string	getWillTopic () const
const ConfigSession &	setWillTopic (const std::string &willTopic) const
std::string	getWillMessage () const
const ConfigSession &	setWillMessage (const std::string &willMessage) const
uint8_t	getWillQoS () const
const ConfigSession &	settWillQoS (uint8_t willQoS) const
bool	getWillRetain () const
const ConfigSession &	setWillRetain (bool willRetain) const
std::string	getUsername () const
const ConfigSession &	settUsername (const std::string &username) const
std::string	getPassword () const
const ConfigSession &	setPassword (const std::string &password) const

Static Public Attributes
static constexpr std::string_view	NAME {"session"}
static constexpr std::string_view	DESCRIPTION {"MQTT session behavior"}

Private Attributes
CLI::Option *	clientIdOpt
CLI::Option *	qoSOpt
CLI::Option *	retainSessionOpt
CLI::Option *	keepAliveOpt
CLI::Option *	willTopicOpt
CLI::Option *	willMessageOpt
CLI::Option *	willQoSOpt
CLI::Option *	willRetainOpt
CLI::Option *	usernameOpt
CLI::Option *	passwordOpt

Detailed Description

Definition at line 98 of file ConfigSections.h.

Constructor & Destructor Documentation

◆ ConfigSession()

mqtt::mqttcli::lib::ConfigSession::ConfigSession ( utils::SubCommand * parent )

Definition at line 123 of file ConfigSections.cpp.

        : utils::SubCommand(parent, this, "Applications")
        , clientIdOpt( //
              setConfigurable(addOption("--client-id", "MQTT Client-ID", "string", CLI::TypeValidator<std::string>()), true))
        , qoSOpt( //
              setConfigurable(addOption("--qos", "Quality of service", "uint8_t", "0", CLI::Range(0, 2)), true))
        , retainSessionOpt( //
              setConfigurable(
                  addFlag("--retain-session{true},-r{true}", "Clean session", "bool", "false", CLI::IsMember({"true", "false"})), true)
                  ->needs(clientIdOpt))
        , keepAliveOpt( //
              setConfigurable(addOption("--keep-alive", "Quality of service", "uint16_t", "60", CLI::TypeValidator<uint16_t>()), true))
        , willTopicOpt( //
              setConfigurable(addOption("--will-topic", "MQTT will topic", "string", CLI::TypeValidator<std::string>()), true))
        , willMessageOpt( //
              setConfigurable(addOption("--will-message", "MQTT will message", "string", CLI::TypeValidator<std::string>()), true))
        , willQoSOpt( //
              setConfigurable(addOption("--will-qos", "MQTT will quality of service", "uint8_t", "0", CLI::TypeValidator<uint8_t>()), true))
        , willRetainOpt( //
              setConfigurable(addFlag("--will-retain{true}", "MQTT will message retain", "bool", "false", CLI::IsMember({"true", "false"})),
                              true))
        , usernameOpt( //
              setConfigurable(addOption("--username", "MQTT username", "string", CLI::TypeValidator<std::string>()), true))
        , passwordOpt( //
              setConfigurable(addOption("--password", "MQTT password", "string", CLI::TypeValidator<std::string>()), true)) {
    }

References clientIdOpt, qoSOpt, and retainSessionOpt.

◆ ~ConfigSession()

mqtt::mqttcli::lib::ConfigSession::~ConfigSession ( )

overridedefault

Member Function Documentation

◆ getClientId()

std::string mqtt::mqttcli::lib::ConfigSession::getClientId ( ) const

Definition at line 152 of file ConfigSections.cpp.

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

References clientIdOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getKeepAlive()

uint16_t mqtt::mqttcli::lib::ConfigSession::getKeepAlive ( ) const

Definition at line 182 of file ConfigSections.cpp.

                                               {
        return keepAliveOpt->as<uint16_t>();
    }

References keepAliveOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getPassword()

std::string mqtt::mqttcli::lib::ConfigSession::getPassword ( ) const

Definition at line 242 of file ConfigSections.cpp.

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

References passwordOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getQoS()

uint8_t mqtt::mqttcli::lib::ConfigSession::getQoS ( ) const

Definition at line 162 of file ConfigSections.cpp.

                                        {
        return qoSOpt->as<uint8_t>();
    }

References qoSOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getRetainSession()

bool mqtt::mqttcli::lib::ConfigSession::getRetainSession ( ) const

Definition at line 172 of file ConfigSections.cpp.

                                               {
        return retainSessionOpt->as<bool>();
    }

References retainSessionOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getUsername()

std::string mqtt::mqttcli::lib::ConfigSession::getUsername ( ) const

Definition at line 232 of file ConfigSections.cpp.

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

References usernameOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getWillMessage()

std::string mqtt::mqttcli::lib::ConfigSession::getWillMessage ( ) const

Definition at line 202 of file ConfigSections.cpp.

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

References willMessageOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getWillQoS()

uint8_t mqtt::mqttcli::lib::ConfigSession::getWillQoS ( ) const

Definition at line 212 of file ConfigSections.cpp.

                                            {
        return willQoSOpt->as<uint8_t>();
    }

References willQoSOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getWillRetain()

bool mqtt::mqttcli::lib::ConfigSession::getWillRetain ( ) const

Definition at line 222 of file ConfigSections.cpp.

                                            {
        return willRetainOpt->as<bool>();
    }

References willRetainOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ getWillTopic()

std::string mqtt::mqttcli::lib::ConfigSession::getWillTopic ( ) const

Definition at line 192 of file ConfigSections.cpp.

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

References willTopicOpt.

Referenced by mqtt::mqttcli::SocketContextFactory::create().

Here is the caller graph for this function:

◆ setClientId()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setClientId ( const std::string & clientId ) const

Definition at line 156 of file ConfigSections.cpp.

                                                                                   {
        clientIdOpt->default_val(clientId)->clear();
 
        return *this;
    }

References clientIdOpt.

◆ setKeepAlive()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setKeepAlive ( uint16_t keepAlive ) const

Definition at line 186 of file ConfigSections.cpp.

                                                                             {
        keepAliveOpt->default_val(keepAlive)->clear();
 
        return *this;
    }

References keepAliveOpt.

◆ setPassword()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setPassword ( const std::string & password ) const

Definition at line 246 of file ConfigSections.cpp.

                                                                                   {
        passwordOpt->default_val(password)->clear();
 
        return *this;
    }

References passwordOpt.

◆ setQos()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setQos ( uint8_t qoS ) const

Definition at line 166 of file ConfigSections.cpp.

                                                                {
        qoSOpt->default_val(qoS)->clear();
 
        return *this;
    }

References qoSOpt.

◆ setRetainSession()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setRetainSession ( bool retainSession ) const

Definition at line 176 of file ConfigSections.cpp.

                                                                                 {
        retainSessionOpt->default_val(retainSession)->clear();
 
        return *this;
    }

References retainSessionOpt.

◆ settUsername()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::settUsername ( const std::string & username ) const

Definition at line 236 of file ConfigSections.cpp.

                                                                                    {
        usernameOpt->default_val(username)->clear();
 
        return *this;
    }

References usernameOpt.

◆ settWillQoS()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::settWillQoS ( uint8_t willQoS ) const

Definition at line 216 of file ConfigSections.cpp.

                                                                         {
        willQoSOpt->default_val(willQoS)->clear();
 
        return *this;
    }

References willQoSOpt.

◆ setWillMessage()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setWillMessage ( const std::string & willMessage ) const

Definition at line 206 of file ConfigSections.cpp.

                                                                                         {
        willMessageOpt->default_val(willMessage)->clear();
 
        return *this;
    }

References willMessageOpt.

◆ setWillRetain()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setWillRetain ( bool willRetain ) const

Definition at line 226 of file ConfigSections.cpp.

                                                                           {
        willRetainOpt->default_val(willRetain)->clear();
 
        return *this;
    }

References willRetainOpt.

◆ setWillTopic()

const ConfigSession & mqtt::mqttcli::lib::ConfigSession::setWillTopic ( const std::string & willTopic ) const

Definition at line 196 of file ConfigSections.cpp.

                                                                                     {
        willTopicOpt->default_val(willTopic)->clear();
 
        return *this;
    }

References willTopicOpt.

Member Data Documentation

◆ clientIdOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::clientIdOpt

private

Definition at line 148 of file ConfigSections.h.

Referenced by ConfigSession(), getClientId(), and setClientId().

◆ DESCRIPTION

std::string_view mqtt::mqttcli::lib::ConfigSession::DESCRIPTION {"MQTT session behavior"}

staticconstexpr

Definition at line 101 of file ConfigSections.h.

101{"MQTT session behavior"};

◆ keepAliveOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::keepAliveOpt

private

Definition at line 151 of file ConfigSections.h.

Referenced by getKeepAlive(), and setKeepAlive().

◆ NAME

std::string_view mqtt::mqttcli::lib::ConfigSession::NAME {"session"}

staticconstexpr

Definition at line 100 of file ConfigSections.h.

100{"session"};

◆ passwordOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::passwordOpt

private

Definition at line 157 of file ConfigSections.h.

Referenced by getPassword(), and setPassword().

◆ qoSOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::qoSOpt

private

Definition at line 149 of file ConfigSections.h.

Referenced by ConfigSession(), getQoS(), and setQos().

◆ retainSessionOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::retainSessionOpt

private

Definition at line 150 of file ConfigSections.h.

Referenced by ConfigSession(), getRetainSession(), and setRetainSession().

◆ usernameOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::usernameOpt

private

Definition at line 156 of file ConfigSections.h.

Referenced by getUsername(), and settUsername().

◆ willMessageOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::willMessageOpt

private

Definition at line 153 of file ConfigSections.h.

Referenced by getWillMessage(), and setWillMessage().

◆ willQoSOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::willQoSOpt

private

Definition at line 154 of file ConfigSections.h.

Referenced by getWillQoS(), and settWillQoS().

◆ willRetainOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::willRetainOpt

private

Definition at line 155 of file ConfigSections.h.

Referenced by getWillRetain(), and setWillRetain().

◆ willTopicOpt

CLI::Option* mqtt::mqttcli::lib::ConfigSession::willTopicOpt

private

Definition at line 152 of file ConfigSections.h.

Referenced by getWillTopic(), and setWillTopic().

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

mqttcli/lib/ConfigSections.h
mqttcli/lib/ConfigSections.cpp

MQTTSuite

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConfigSession()

◆ ~ConfigSession()

Member Function Documentation

◆ getClientId()

◆ getKeepAlive()

◆ getPassword()

◆ getQoS()

◆ getRetainSession()

◆ getUsername()

◆ getWillMessage()

◆ getWillQoS()

◆ getWillRetain()

◆ getWillTopic()

◆ setClientId()

◆ setKeepAlive()

◆ setPassword()

◆ setQos()

◆ setRetainSession()

◆ settUsername()

◆ settWillQoS()

◆ setWillMessage()

◆ setWillRetain()

◆ setWillTopic()

Member Data Documentation

◆ clientIdOpt

◆ DESCRIPTION

◆ keepAliveOpt

◆ NAME

◆ passwordOpt

◆ qoSOpt

◆ retainSessionOpt

◆ usernameOpt

◆ willMessageOpt

◆ willQoSOpt

◆ willRetainOpt

◆ willTopicOpt