mqttfailure.h
1.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#ifndef OSDEV_COMPONENTS_MQTT_MQTTFAILURE_H
#define OSDEV_COMPONENTS_MQTT_MQTTFAILURE_H
// std
#include <string>
// paho
#include <MQTTAsync.h>
namespace osdev {
namespace components {
namespace mqtt {
/*!
* \brief Class for paho mqtt failure response data.
*/
class MqttFailure
{
public:
/*!
* \brief Construct MqttFailure instance by copying information from the paho failure struct.
* \param data Paho response failure data.
*/
explicit MqttFailure(const MQTTAsync_failureData* data);
/*!
* \return The command token
*/
MQTTAsync_token token() const { return m_token; }
/*!
* \return The failure code.
*/
int code() const { return m_code; }
/*!
* \return The failure message.
* \retval "no message" when no message is available.
*/
const std::string& message() const { return m_message; }
/*!
* \return string interpretation of the code.
* \note negative codes are interpreted as paho error codes.
*/
std::string codeToString() const;
private:
MQTTAsync_token m_token; ///< Command token.
int m_code; ///< Failure code.
std::string m_message; ///< Optional message. Equal to "no message" when message is not available.
};
} // End namespace mqtt
} // End namespace components
} // End namespace osdev
#endif // OSDEV_COMPONENTS_MQTT_MQTTFAILURE_H