Paho MQTT C Client Library: MQTTReasonCodes.h File Reference

| Paho MQTT C Client Library

Enumerations | Functions
MQTTReasonCodes.h File Reference
`#include "MQTTExportDeclarations.h"`

Go to the source code of this file.

## Enumerations
enum | MQTTReasonCodes { MQTTREASONCODE_SUCCESS = 0 , MQTTREASONCODE_NORMAL_DISCONNECTION = 0 , MQTTREASONCODE_GRANTED_QOS_0 = 0 , MQTTREASONCODE_GRANTED_QOS_1 = 1 , MQTTREASONCODE_GRANTED_QOS_2 = 2 , MQTTREASONCODE_DISCONNECT_WITH_WILL_MESSAGE = 4 , MQTTREASONCODE_NO_MATCHING_SUBSCRIBERS = 16 , MQTTREASONCODE_NO_SUBSCRIPTION_FOUND = 17 , MQTTREASONCODE_CONTINUE_AUTHENTICATION = 24 , MQTTREASONCODE_RE_AUTHENTICATE = 25 , MQTTREASONCODE_UNSPECIFIED_ERROR = 128 , MQTTREASONCODE_MALFORMED_PACKET = 129 , MQTTREASONCODE_PROTOCOL_ERROR = 130 , MQTTREASONCODE_IMPLEMENTATION_SPECIFIC_ERROR = 131 , MQTTREASONCODE_UNSUPPORTED_PROTOCOL_VERSION = 132 , MQTTREASONCODE_CLIENT_IDENTIFIER_NOT_VALID = 133 , MQTTREASONCODE_BAD_USER_NAME_OR_PASSWORD = 134 , MQTTREASONCODE_NOT_AUTHORIZED = 135 , MQTTREASONCODE_SERVER_UNAVAILABLE = 136 , MQTTREASONCODE_SERVER_BUSY = 137 , MQTTREASONCODE_BANNED = 138 , MQTTREASONCODE_SERVER_SHUTTING_DOWN = 139 , MQTTREASONCODE_BAD_AUTHENTICATION_METHOD = 140 , MQTTREASONCODE_KEEP_ALIVE_TIMEOUT = 141 , MQTTREASONCODE_SESSION_TAKEN_OVER = 142 , MQTTREASONCODE_TOPIC_FILTER_INVALID = 143 , MQTTREASONCODE_TOPIC_NAME_INVALID = 144 , MQTTREASONCODE_PACKET_IDENTIFIER_IN_USE = 145 , MQTTREASONCODE_PACKET_IDENTIFIER_NOT_FOUND = 146 , MQTTREASONCODE_RECEIVE_MAXIMUM_EXCEEDED = 147 , MQTTREASONCODE_TOPIC_ALIAS_INVALID = 148 , MQTTREASONCODE_PACKET_TOO_LARGE = 149 , MQTTREASONCODE_MESSAGE_RATE_TOO_HIGH = 150 , MQTTREASONCODE_QUOTA_EXCEEDED = 151 , MQTTREASONCODE_ADMINISTRATIVE_ACTION = 152 , MQTTREASONCODE_PAYLOAD_FORMAT_INVALID = 153 , MQTTREASONCODE_RETAIN_NOT_SUPPORTED = 154 , MQTTREASONCODE_QOS_NOT_SUPPORTED = 155 , MQTTREASONCODE_USE_ANOTHER_SERVER = 156 , MQTTREASONCODE_SERVER_MOVED = 157 , MQTTREASONCODE_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 158 , MQTTREASONCODE_CONNECTION_RATE_EXCEEDED = 159 , MQTTREASONCODE_MAXIMUM_CONNECT_TIME = 160 , MQTTREASONCODE_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED = 161 , MQTTREASONCODE_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 162 }

## Functions
const char * | MQTTReasonCode_toString (enum MQTTReasonCodes value)

## Enumeration Type Documentation

## ◆ MQTTReasonCodes

enum MQTTReasonCodes

The MQTT V5 one byte reason code

Enumerator
MQTTREASONCODE_SUCCESS |
MQTTREASONCODE_NORMAL_DISCONNECTION |
MQTTREASONCODE_GRANTED_QOS_0 |
MQTTREASONCODE_GRANTED_QOS_1 |
MQTTREASONCODE_GRANTED_QOS_2 |
MQTTREASONCODE_DISCONNECT_WITH_WILL_MESSAGE |
MQTTREASONCODE_NO_MATCHING_SUBSCRIBERS |
MQTTREASONCODE_NO_SUBSCRIPTION_FOUND |
MQTTREASONCODE_CONTINUE_AUTHENTICATION |
MQTTREASONCODE_RE_AUTHENTICATE |
MQTTREASONCODE_UNSPECIFIED_ERROR |
MQTTREASONCODE_MALFORMED_PACKET |
MQTTREASONCODE_PROTOCOL_ERROR |
MQTTREASONCODE_IMPLEMENTATION_SPECIFIC_ERROR |
MQTTREASONCODE_UNSUPPORTED_PROTOCOL_VERSION |
MQTTREASONCODE_CLIENT_IDENTIFIER_NOT_VALID |
MQTTREASONCODE_BAD_USER_NAME_OR_PASSWORD |
MQTTREASONCODE_NOT_AUTHORIZED |
MQTTREASONCODE_SERVER_UNAVAILABLE |
MQTTREASONCODE_SERVER_BUSY |
MQTTREASONCODE_BANNED |
MQTTREASONCODE_SERVER_SHUTTING_DOWN |
MQTTREASONCODE_BAD_AUTHENTICATION_METHOD |
MQTTREASONCODE_KEEP_ALIVE_TIMEOUT |
MQTTREASONCODE_SESSION_TAKEN_OVER |
MQTTREASONCODE_TOPIC_FILTER_INVALID |
MQTTREASONCODE_TOPIC_NAME_INVALID |
MQTTREASONCODE_PACKET_IDENTIFIER_IN_USE |
MQTTREASONCODE_PACKET_IDENTIFIER_NOT_FOUND |
MQTTREASONCODE_RECEIVE_MAXIMUM_EXCEEDED |
MQTTREASONCODE_TOPIC_ALIAS_INVALID |
MQTTREASONCODE_PACKET_TOO_LARGE |
MQTTREASONCODE_MESSAGE_RATE_TOO_HIGH |
MQTTREASONCODE_QUOTA_EXCEEDED |
MQTTREASONCODE_ADMINISTRATIVE_ACTION |
MQTTREASONCODE_PAYLOAD_FORMAT_INVALID |
MQTTREASONCODE_RETAIN_NOT_SUPPORTED |
MQTTREASONCODE_QOS_NOT_SUPPORTED |
MQTTREASONCODE_USE_ANOTHER_SERVER |
MQTTREASONCODE_SERVER_MOVED |
MQTTREASONCODE_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED |
MQTTREASONCODE_CONNECTION_RATE_EXCEEDED |
MQTTREASONCODE_MAXIMUM_CONNECT_TIME |
MQTTREASONCODE_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED |
MQTTREASONCODE_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED |

## Function Documentation

## ◆ MQTTReasonCode_toString()

const char* MQTTReasonCode_toString | ( | enum MQTTReasonCodes | value | ) |

Returns a printable string description of an MQTT V5 reason code.

Parameters

  value | an MQTT V5 reason code.

Returns
  the printable string description of the input reason code. NULL if the code was not found.