iot::mqtt::client::Mqtt Class Reference

#include <Mqtt.h>

Inheritance diagram for iot::mqtt::client::Mqtt:

Collaboration diagram for iot::mqtt::client::Mqtt:

Public Types
using	Super = iot::mqtt::Mqtt

Public Member Functions
	Mqtt (const std::string &connectionName, const std::string &clientId)
	~Mqtt () override
void	sendConnect (uint16_t keepAlive, const std::string &clientId, bool cleanSession, const std::string &willTopic, const std::string &willMessage, uint8_t willQoS, bool willRetain, const std::string &username, const std::string &password, bool loopPrevention=false)
void	sendSubscribe (const std::list< Topic > &topics)
void	sendUnsubscribe (const std::list< std::string > &topics)
void	sendPingreq () const
void	sendDisconnect () const
Public Member Functions inherited from iot::mqtt::Mqtt
	Mqtt (const std::string &connectionName)
	Mqtt (const std::string &connectionName, const std::string &clientId)
	Mqtt (Mqtt &&)=delete
	Mqtt (const Mqtt &)=delete
Mqtt &	operator= (Mqtt &&)=delete
Mqtt &	operator= (const Mqtt &)=delete
virtual void	onConnected ()
virtual void	onDisconnected ()
const std::string &	getConnectionName () const
const MqttContext *	getMqttContext () const
void	sendPublish (const std::string &topic, const std::string &message, uint8_t qoS, bool retain)
void	sendPuback (uint16_t packetIdentifier) const
void	sendPubrec (uint16_t packetIdentifier) const
void	sendPubrel (uint16_t packetIdentifier) const
void	sendPubcomp (uint16_t packetIdentifier) const

Protected Member Functions
bool	onSignal (int sig) override
Protected Member Functions inherited from iot::mqtt::Mqtt
void	initSession (Session *session, utils::Timeval keepAlive)
virtual void	onPublish (const iot::mqtt::packets::Publish &publish)
virtual void	onPuback (const iot::mqtt::packets::Puback &puback)
virtual void	onPubrec (const iot::mqtt::packets::Pubrec &pubrec)
virtual void	onPubrel (const iot::mqtt::packets::Pubrel &pubrel)
virtual void	onPubcomp (const iot::mqtt::packets::Pubcomp &pubcomp)
bool	_onPublish (const iot::mqtt::packets::Publish &publish)
void	_onPuback (const iot::mqtt::packets::Puback &puback)
void	_onPubrec (const iot::mqtt::packets::Pubrec &pubrec)
void	_onPubrel (const iot::mqtt::packets::Pubrel &pubrel)
void	_onPubcomp (const iot::mqtt::packets::Pubcomp &pubcomp)
uint16_t	getPacketIdentifier ()
void	send (const iot::mqtt::ControlPacket &controlPacket) const
void	printVP (const iot::mqtt::ControlPacket &packet) const
void	printFixedHeader (const iot::mqtt::FixedHeader &fixedHeader) const

Private Member Functions
iot::mqtt::ControlPacketDeserializer *	createControlPacketDeserializer (iot::mqtt::FixedHeader &fixedHeader) final
void	deliverPacket (iot::mqtt::ControlPacketDeserializer *controlPacketDeserializer) override
virtual void	onConnack (const iot::mqtt::packets::Connack &connack)
virtual void	onSuback (const iot::mqtt::packets::Suback &suback)
virtual void	onUnsuback (const iot::mqtt::packets::Unsuback &unsuback)
virtual void	onPingresp (const iot::mqtt::packets::Pingresp &pingresp)
void	_onConnack (const iot::mqtt::client::packets::Connack &connack)
void	_onPublish (const iot::mqtt::client::packets::Publish &publish)
void	_onSuback (const iot::mqtt::client::packets::Suback &suback)
void	_onUnsuback (const iot::mqtt::client::packets::Unsuback &unsuback)
void	_onPingresp (const iot::mqtt::client::packets::Pingresp &pingresp)

Private Attributes
uint16_t	keepAlive = 0
std::string	sessionStoreFileName
iot::mqtt::Session	session
core::timer::Timer	pingTimer

Friends
class	iot::mqtt::client::packets::Connack
class	iot::mqtt::client::packets::Suback
class	iot::mqtt::client::packets::Unsuback
class	iot::mqtt::client::packets::Pingresp
class	iot::mqtt::client::packets::Publish
class	iot::mqtt::client::packets::Pubcomp
class	iot::mqtt::client::packets::Pubrec
class	iot::mqtt::client::packets::Puback
class	iot::mqtt::client::packets::Pubrel

Additional Inherited Members
Static Public Member Functions inherited from iot::mqtt::Mqtt
static std::string	toHexString (const std::vector< char > &data)
static std::string	toHexString (const std::string &data)
Protected Attributes inherited from iot::mqtt::Mqtt
std::string	connectionName
std::string	clientId
MqttContext *	mqttContext = nullptr

Detailed Description

Definition at line 62 of file Mqtt.h.

Member Typedef Documentation

Super

using iot::mqtt::client::Mqtt::Super = iot::mqtt::Mqtt

Definition at line 64 of file Mqtt.h.

Constructor & Destructor Documentation

Mqtt()

iot::mqtt::client::Mqtt::Mqtt ( const std::string & connectionName, const std::string & clientId )

explicit

Definition at line 57 of file Mqtt.cpp.

        : Super(connectionName, clientId)
        , sessionStoreFileName((getenv("MQTT_SESSION_STORE") != nullptr) ? getenv("MQTT_SESSION_STORE") : "") { // NOLINT
        if (!sessionStoreFileName.empty()) {
            std::ifstream sessionStoreFile(sessionStoreFileName);
 
            if (sessionStoreFile.is_open()) {
                try {
                    nlohmann::json sessionStoreJson;
 
                    sessionStoreFile >> sessionStoreJson;
 
                    session.fromJson(sessionStoreJson);
 
                    LOG(DEBUG) << connectionName << " MQTT Client:   ... Persistent session data loaded successful";
                } catch (const nlohmann::json::exception&) {
                    LOG(DEBUG) << connectionName << " MQTT Client:   ... Starting with empty session: Session store '"
                               << sessionStoreFileName << "' empty or corrupted";
 
                    session.clear();
                }
 
                sessionStoreFile.close();
                std::remove(sessionStoreFileName.data()); // NOLINT
 
                LOG(INFO) << connectionName << " MQTT Client: Restoring saved session done";
            } else {
                PLOG(WARNING) << connectionName << " MQTT Client:   ... Could not read session store '" << sessionStoreFileName << "'";
            }
        } else {
            LOG(INFO) << connectionName << " MQTT Client: Session not reloaded: Session store filename empty";
        }
    }

References Mqtt().

Referenced by Mqtt().

Here is the call graph for this function:

Here is the caller graph for this function:

~Mqtt()

iot::mqtt::client::Mqtt::~Mqtt ( )

overridevirtual

Reimplemented from iot::mqtt::Mqtt.

Definition at line 91 of file Mqtt.cpp.

                {
        if (!sessionStoreFileName.empty()) {
            const nlohmann::json sessionJson = session.toJson();
 
            std::ofstream sessionStoreFile(sessionStoreFileName);
 
            if (sessionStoreFile.is_open()) {
                if (!sessionJson.empty()) {
                    sessionStoreFile << sessionJson;
                }
 
                sessionStoreFile.close();
            } else {
                PLOG(DEBUG) << connectionName << " MQTT Client: Could not write session store '" << sessionStoreFileName << "'";
            }
        } else {
            LOG(INFO) << connectionName << " MQTT Client: Session not saved: Session store filename empty";
        }
 
        pingTimer.cancel();
    }

Member Function Documentation

_onConnack()

void iot::mqtt::client::Mqtt::_onConnack ( const iot::mqtt::client::packets::Connack & connack )

private

Definition at line 172 of file Mqtt.cpp.

                                                                    {
        LOG(INFO) << connectionName << " MQTT Client:   Acknowledge Flag: " << static_cast<int>(connack.getAcknowledgeFlags());
        LOG(INFO) << connectionName << " MQTT Client:   Return code: " << static_cast<int>(connack.getReturnCode());
        LOG(INFO) << connectionName << " MQTT Client:   Session present: " << connack.getSessionPresent();
 
        if (connack.getReturnCode() != MQTT_CONNACK_ACCEPT) {
            LOG(ERROR) << connectionName << " MQTT Client:   Negative ack received";
        } else {
            initSession(&session, keepAlive);
 
            pingTimer = core::timer::Timer::intervalTimer(
                [this]() {
                    sendPingreq();
                },
                keepAlive);
 
            onConnack(connack);
        }
    }

References onConnack().

Here is the call graph for this function:

_onPingresp()

void iot::mqtt::client::Mqtt::_onPingresp ( const iot::mqtt::client::packets::Pingresp & pingresp )

private

Definition at line 236 of file Mqtt.cpp.

                                                                       {
        onPingresp(pingresp);
    }

References onPingresp().

Here is the call graph for this function:

_onPublish()

void iot::mqtt::client::Mqtt::_onPublish ( const iot::mqtt::client::packets::Publish & publish )

private

Definition at line 192 of file Mqtt.cpp.

                                                                    {
        if (Super::_onPublish(publish)) {
            onPublish(publish);
        }
    }

_onSuback()

void iot::mqtt::client::Mqtt::_onSuback ( const iot::mqtt::client::packets::Suback & suback )

private

Definition at line 198 of file Mqtt.cpp.

                                                                 {
        if (suback.getPacketIdentifier() == 0) {
            LOG(ERROR) << connectionName << " MQTT Client:   PackageIdentifier missing";
            mqttContext->end(true);
        } else {
            LOG(DEBUG) << connectionName << " MQTT Client:  PacketIdentifier: 0x" << std::hex << std::setfill('0') << std::setw(4)
                       << suback.getPacketIdentifier();
 
            std::stringstream ss;
            std::list<uint8_t>::size_type i = 0;
 
            for (const uint8_t returnCode : suback.getReturnCodes()) {
                if (i != 0 && i % 8 == 0 && i != suback.getReturnCodes().size()) {
                    ss << std::endl;
                    ss << "                                                       ";
                }
                ++i;
                ss << "0x" << std::hex << std::setfill('0') << std::setw(2) << static_cast<uint16_t>(returnCode) << " "; // << " | ";
            }
 
            LOG(DEBUG) << connectionName << " MQTT Client:  Return codes: " << ss.str();
 
            onSuback(suback);
        }
    }

References onSuback().

Here is the call graph for this function:

_onUnsuback()

void iot::mqtt::client::Mqtt::_onUnsuback ( const iot::mqtt::client::packets::Unsuback & unsuback )

private

Definition at line 224 of file Mqtt.cpp.

                                                                       {
        if (unsuback.getPacketIdentifier() == 0) {
            LOG(ERROR) << connectionName << " MQTT Client:  PacketIdentifier missing";
            mqttContext->end(true);
        } else {
            LOG(DEBUG) << connectionName << " MQTT Client:  PacketIdentifier: 0x" << std::hex << std::setfill('0') << std::setw(4)
                       << unsuback.getPacketIdentifier();
 
            onUnsuback(unsuback);
        }
    }

References onUnsuback().

Here is the call graph for this function:

createControlPacketDeserializer()

iot::mqtt::ControlPacketDeserializer * iot::mqtt::client::Mqtt::createControlPacketDeserializer ( iot::mqtt::FixedHeader & fixedHeader )

finalprivatevirtual

Implements iot::mqtt::Mqtt.

Definition at line 113 of file Mqtt.cpp.

                                                                                                           {
        iot::mqtt::ControlPacketDeserializer* currentPacket = nullptr;
 
        switch (fixedHeader.getType()) {
            case MQTT_CONNACK:
                currentPacket = new iot::mqtt::client::packets::Connack(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PUBLISH:
                currentPacket = new iot::mqtt::client::packets::Publish(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PUBACK:
                currentPacket = new iot::mqtt::client::packets::Puback(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PUBREC:
                currentPacket = new iot::mqtt::client::packets::Pubrec(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PUBREL:
                currentPacket = new iot::mqtt::client::packets::Pubrel(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PUBCOMP:
                currentPacket = new iot::mqtt::client::packets::Pubcomp(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_SUBACK:
                currentPacket = new iot::mqtt::client::packets::Suback(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_UNSUBACK:
                currentPacket = new iot::mqtt::client::packets::Unsuback(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            case MQTT_PINGRESP:
                currentPacket = new iot::mqtt::client::packets::Pingresp(fixedHeader.getRemainingLength(), fixedHeader.getFlags());
                break;
            default:
                currentPacket = nullptr;
                break;
        }
 
        return currentPacket;
    }

deliverPacket()

void iot::mqtt::client::Mqtt::deliverPacket ( iot::mqtt::ControlPacketDeserializer * controlPacketDeserializer )

overrideprivatevirtual

Implements iot::mqtt::Mqtt.

Definition at line 152 of file Mqtt.cpp.

                                                                                        {
        static_cast<iot::mqtt::client::ControlPacketDeserializer*>(controlPacketDeserializer)->deliverPacket(this); // NOLINT
    }

onConnack()

void iot::mqtt::client::Mqtt::onConnack ( const iot::mqtt::packets::Connack & connack )

privatevirtual

Definition at line 160 of file Mqtt.cpp.

                                                                           {
    }

Referenced by _onConnack().

Here is the caller graph for this function:

onPingresp()

void iot::mqtt::client::Mqtt::onPingresp ( const iot::mqtt::packets::Pingresp & pingresp )

privatevirtual

Definition at line 169 of file Mqtt.cpp.

                                                                              {
    }

Referenced by _onPingresp().

Here is the caller graph for this function:

onSignal()

bool iot::mqtt::client::Mqtt::onSignal ( int sig )

overrideprotectedvirtual

Implements iot::mqtt::Mqtt.

Definition at line 156 of file Mqtt.cpp.

                                                {
        return false;
    }

onSuback()

void iot::mqtt::client::Mqtt::onSuback ( const iot::mqtt::packets::Suback & suback )

privatevirtual

Definition at line 163 of file Mqtt.cpp.

                                                                        {
    }

Referenced by _onSuback().

Here is the caller graph for this function:

onUnsuback()

void iot::mqtt::client::Mqtt::onUnsuback ( const iot::mqtt::packets::Unsuback & unsuback )

privatevirtual

Definition at line 166 of file Mqtt.cpp.

                                                                              {
    }

Referenced by _onUnsuback().

Here is the caller graph for this function:

sendConnect()

void iot::mqtt::client::Mqtt::sendConnect	(	uint16_t	keepAlive,
		const std::string &	clientId,
		bool	cleanSession,
		const std::string &	willTopic,
		const std::string &	willMessage,
		uint8_t	willQoS,
		bool	willRetain,
		const std::string &	username,
		const std::string &	password,
		bool	loopPrevention = false )

Definition at line 240 of file Mqtt.cpp.

                                                { // Client
        this->clientId = clientId;
 
        LOG(INFO) << connectionName << " MQTT Client: CONNECT send: " << clientId;
 
        send(iot::mqtt::packets::Connect(
            clientId, keepAlive, cleanSession, willTopic, willMessage, willQoS, willRetain, username, password, loopPrevention));
 
        this->keepAlive = keepAlive;
    }

References keepAlive.

sendDisconnect()

void iot::mqtt::client::Mqtt::sendDisconnect

(

)

const

Definition at line 272 of file Mqtt.cpp.

                                    { // Client
        send(iot::mqtt::packets::Disconnect());
 
        mqttContext->end();
    }

sendPingreq()

void iot::mqtt::client::Mqtt::sendPingreq

(

)

const

Definition at line 268 of file Mqtt.cpp.

                                 { // Client
        send(iot::mqtt::packets::Pingreq());
    }

sendSubscribe()

void iot::mqtt::client::Mqtt::sendSubscribe

(

const std::list< Topic > &

topics

)

Definition at line 260 of file Mqtt.cpp.

                                                                { // Client
        send(iot::mqtt::packets::Subscribe(getPacketIdentifier(), topics));
    }

sendUnsubscribe()

void iot::mqtt::client::Mqtt::sendUnsubscribe

(

const std::list< std::string > &

topics

)

Definition at line 264 of file Mqtt.cpp.

                                                               { // Client
        send(iot::mqtt::packets::Unsubscribe(getPacketIdentifier(), topics));
    }

Friends And Related Symbol Documentation

iot::mqtt::client::packets::Connack

friend class iot::mqtt::client::packets::Connack

friend

Definition at line 105 of file Mqtt.h.

iot::mqtt::client::packets::Pingresp

friend class iot::mqtt::client::packets::Pingresp

friend

Definition at line 108 of file Mqtt.h.

iot::mqtt::client::packets::Puback

friend class iot::mqtt::client::packets::Puback

friend

Definition at line 112 of file Mqtt.h.

iot::mqtt::client::packets::Pubcomp

friend class iot::mqtt::client::packets::Pubcomp

friend

Definition at line 110 of file Mqtt.h.

iot::mqtt::client::packets::Publish

friend class iot::mqtt::client::packets::Publish

friend

Definition at line 109 of file Mqtt.h.

iot::mqtt::client::packets::Pubrec

friend class iot::mqtt::client::packets::Pubrec

friend

Definition at line 111 of file Mqtt.h.

iot::mqtt::client::packets::Pubrel

friend class iot::mqtt::client::packets::Pubrel

friend

Definition at line 113 of file Mqtt.h.

iot::mqtt::client::packets::Suback

friend class iot::mqtt::client::packets::Suback

friend

Definition at line 106 of file Mqtt.h.

iot::mqtt::client::packets::Unsuback

friend class iot::mqtt::client::packets::Unsuback

friend

Definition at line 107 of file Mqtt.h.

Member Data Documentation

keepAlive

uint16_t iot::mqtt::client::Mqtt::keepAlive = 0

private

Definition at line 116 of file Mqtt.h.

Referenced by sendConnect().

pingTimer

core::timer::Timer iot::mqtt::client::Mqtt::pingTimer

private

Definition at line 121 of file Mqtt.h.

session

iot::mqtt::Session iot::mqtt::client::Mqtt::session

private

Definition at line 119 of file Mqtt.h.

sessionStoreFileName

std::string iot::mqtt::client::Mqtt::sessionStoreFileName

private

Definition at line 118 of file Mqtt.h.

---

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

• iot/mqtt/client/Mqtt.h
• iot/mqtt/client/Mqtt.cpp