| .TH "MQTTReasonCodes.h" 3 "Thu Sep 13 2018" "Paho Asynchronous MQTT C Client Library" \" -*- nroff -*- |
| .ad l |
| .nh |
| .SH NAME |
| MQTTReasonCodes.h |
| .SH SYNOPSIS |
| .br |
| .PP |
| .SS "Macros" |
| |
| .in +1c |
| .ti -1c |
| .RI "#define \fBDLLImport\fP extern" |
| .br |
| .ti -1c |
| .RI "#define \fBDLLExport\fP __attribute__ ((visibility ('default')))" |
| .br |
| .in -1c |
| .SS "Enumerations" |
| |
| .in +1c |
| .ti -1c |
| .RI "enum \fBMQTTReasonCodes\fP { \fBMQTTREASONCODE_SUCCESS\fP = 0, \fBMQTTREASONCODE_NORMAL_DISCONNECTION\fP = 0, \fBMQTTREASONCODE_GRANTED_QOS_0\fP = 0, \fBMQTTREASONCODE_GRANTED_QOS_1\fP = 1, \fBMQTTREASONCODE_GRANTED_QOS_2\fP = 2, \fBMQTTREASONCODE_DISCONNECT_WITH_WILL_MESSAGE\fP = 4, \fBMQTTREASONCODE_NO_MATCHING_SUBSCRIBERS\fP = 16, \fBMQTTREASONCODE_NO_SUBSCRIPTION_FOUND\fP = 17, \fBMQTTREASONCODE_CONTINUE_AUTHENTICATION\fP = 24, \fBMQTTREASONCODE_RE_AUTHENTICATE\fP = 25, \fBMQTTREASONCODE_UNSPECIFIED_ERROR\fP = 128, \fBMQTTREASONCODE_MALFORMED_PACKET\fP = 129, \fBMQTTREASONCODE_PROTOCOL_ERROR\fP = 130, \fBMQTTREASONCODE_IMPLEMENTATION_SPECIFIC_ERROR\fP = 131, \fBMQTTREASONCODE_UNSUPPORTED_PROTOCOL_VERSION\fP = 132, \fBMQTTREASONCODE_CLIENT_IDENTIFIER_NOT_VALID\fP = 133, \fBMQTTREASONCODE_BAD_USER_NAME_OR_PASSWORD\fP = 134, \fBMQTTREASONCODE_NOT_AUTHORIZED\fP = 135, \fBMQTTREASONCODE_SERVER_UNAVAILABLE\fP = 136, \fBMQTTREASONCODE_SERVER_BUSY\fP = 137, \fBMQTTREASONCODE_BANNED\fP = 138, \fBMQTTREASONCODE_SERVER_SHUTTING_DOWN\fP = 139, \fBMQTTREASONCODE_BAD_AUTHENTICATION_METHOD\fP = 140, \fBMQTTREASONCODE_KEEP_ALIVE_TIMEOUT\fP = 141, \fBMQTTREASONCODE_SESSION_TAKEN_OVER\fP = 142, \fBMQTTREASONCODE_TOPIC_FILTER_INVALID\fP = 143, \fBMQTTREASONCODE_TOPIC_NAME_INVALID\fP = 144, \fBMQTTREASONCODE_PACKET_IDENTIFIER_IN_USE\fP = 145, \fBMQTTREASONCODE_PACKET_IDENTIFIER_NOT_FOUND\fP = 146, \fBMQTTREASONCODE_RECEIVE_MAXIMUM_EXCEEDED\fP = 147, \fBMQTTREASONCODE_TOPIC_ALIAS_INVALID\fP = 148, \fBMQTTREASONCODE_PACKET_TOO_LARGE\fP = 149, \fBMQTTREASONCODE_MESSAGE_RATE_TOO_HIGH\fP = 150, \fBMQTTREASONCODE_QUOTA_EXCEEDED\fP = 151, \fBMQTTREASONCODE_ADMINISTRATIVE_ACTION\fP = 152, \fBMQTTREASONCODE_PAYLOAD_FORMAT_INVALID\fP = 153, \fBMQTTREASONCODE_RETAIN_NOT_SUPPORTED\fP = 154, \fBMQTTREASONCODE_QOS_NOT_SUPPORTED\fP = 155, \fBMQTTREASONCODE_USE_ANOTHER_SERVER\fP = 156, \fBMQTTREASONCODE_SERVER_MOVED\fP = 157, \fBMQTTREASONCODE_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED\fP = 158, \fBMQTTREASONCODE_CONNECTION_RATE_EXCEEDED\fP = 159, \fBMQTTREASONCODE_MAXIMUM_CONNECT_TIME\fP = 160, \fBMQTTREASONCODE_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED\fP = 161, \fBMQTTREASONCODE_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED\fP = 162 }" |
| .br |
| .in -1c |
| .SS "Functions" |
| |
| .in +1c |
| .ti -1c |
| .RI "const char * \fBMQTTReasonCode_toString\fP (enum \fBMQTTReasonCodes\fP value)" |
| .br |
| .in -1c |
| .SH "Macro Definition Documentation" |
| .PP |
| .SS "#define DLLImport extern" |
| |
| .SS "#define DLLExport __attribute__ ((visibility ('default')))" |
| |
| .SH "Enumeration Type Documentation" |
| .PP |
| .SS "enum \fBMQTTReasonCodes\fP" |
| The MQTT V5 one byte reason code |
| .PP |
| \fBEnumerator\fP |
| .in +1c |
| .TP |
| \fB\fIMQTTREASONCODE_SUCCESS \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_NORMAL_DISCONNECTION \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_GRANTED_QOS_0 \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_GRANTED_QOS_1 \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_GRANTED_QOS_2 \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_DISCONNECT_WITH_WILL_MESSAGE \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_NO_MATCHING_SUBSCRIBERS \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_NO_SUBSCRIPTION_FOUND \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_CONTINUE_AUTHENTICATION \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_RE_AUTHENTICATE \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_UNSPECIFIED_ERROR \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_MALFORMED_PACKET \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_PROTOCOL_ERROR \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_IMPLEMENTATION_SPECIFIC_ERROR \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_UNSUPPORTED_PROTOCOL_VERSION \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_CLIENT_IDENTIFIER_NOT_VALID \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_BAD_USER_NAME_OR_PASSWORD \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_NOT_AUTHORIZED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SERVER_UNAVAILABLE \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SERVER_BUSY \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_BANNED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SERVER_SHUTTING_DOWN \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_BAD_AUTHENTICATION_METHOD \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_KEEP_ALIVE_TIMEOUT \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SESSION_TAKEN_OVER \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_TOPIC_FILTER_INVALID \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_TOPIC_NAME_INVALID \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_PACKET_IDENTIFIER_IN_USE \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_PACKET_IDENTIFIER_NOT_FOUND \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_RECEIVE_MAXIMUM_EXCEEDED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_TOPIC_ALIAS_INVALID \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_PACKET_TOO_LARGE \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_MESSAGE_RATE_TOO_HIGH \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_QUOTA_EXCEEDED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_ADMINISTRATIVE_ACTION \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_PAYLOAD_FORMAT_INVALID \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_RETAIN_NOT_SUPPORTED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_QOS_NOT_SUPPORTED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_USE_ANOTHER_SERVER \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SERVER_MOVED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_CONNECTION_RATE_EXCEEDED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_MAXIMUM_CONNECT_TIME \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED \fP\fP |
| .TP |
| \fB\fIMQTTREASONCODE_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED \fP\fP |
| .SH "Function Documentation" |
| .PP |
| .SS "const char* MQTTReasonCode_toString (enum \fBMQTTReasonCodes\fP value)" |
| Returns a printable string description of an MQTT V5 reason code\&. |
| .PP |
| \fBParameters:\fP |
| .RS 4 |
| \fIvalue\fP an MQTT V5 reason code\&. |
| .RE |
| .PP |
| \fBReturns:\fP |
| .RS 4 |
| the printable string description of the input reason code\&. NULL if the code was not found\&. |
| .RE |
| .PP |
| |
| .SH "Author" |
| .PP |
| Generated automatically by Doxygen for Paho Asynchronous MQTT C Client Library from the source code\&. |
