kmMqtt::mqtt::ReqResult Class Reference

Contains the result of an MQTT client request operation. More...

#include <ReqResult.h>

Public Member Functions
bool	noError () const noexcept
	Checks if the request resulted in no error.
bool	hasPacketId () const noexcept
	Checks if a valid packet identifier is associated with the request.
ClientErrorCode	errorCode () const noexcept
	Retrieves the error code associated with the request.
const char *	errorMsg () const noexcept
	Retrieves the error message associated with the request.

Detailed Description

Contains the result of an MQTT client request operation.

Includes any error information and the associated packet identifier if applicable.

Member Function Documentation

errorCode()

ClientErrorCode kmMqtt::mqtt::ReqResult::errorCode ( ) const

inlinenoexcept

Retrieves the error code associated with the request.

Returns

The ClientErrorCode of the request.

errorMsg()

const char * kmMqtt::mqtt::ReqResult::errorMsg ( ) const

inlinenoexcept

Retrieves the error message associated with the request.

Returns

The error message as a C-style string.

hasPacketId()

bool kmMqtt::mqtt::ReqResult::hasPacketId ( ) const

inlinenoexcept

Checks if a valid packet identifier is associated with the request.

Returns

true if a valid packet identifier exists; false otherwise.

noError()

bool kmMqtt::mqtt::ReqResult::noError ( ) const

inlinenoexcept

Checks if the request resulted in no error.

Returns

true if there was no error; false otherwise.

---

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

• D:/Dev/Repos/kmMqtt/include/public/kmMqtt/Mqtt/ReqResult.h