Definition of error types for the SDK.
Enumerations | |
| enum | IoT_Error_t { RECONNECT_SUCCESSFUL = 1, NONE_ERROR = 0, GENERIC_ERROR = -1, NULL_VALUE_ERROR = -2, CONNECTION_ERROR = -3, SUBSCRIBE_ERROR = -4, PUBLISH_ERROR = -5, DISCONNECT_ERROR = -6, YIELD_ERROR = -7, TCP_CONNECT_ERROR = -8, SSL_CONNECT_ERROR = -9, TCP_SETUP_ERROR =-10, SSL_CONNECT_TIMEOUT_ERROR = -11, SSL_WRITE_ERROR = -12, SSL_INIT_ERROR = -13, SSL_CERT_ERROR = -14, UNSUBSCRIBE_ERROR = -15, JSON_PARSE_ERROR = -16, WAIT_FOR_PUBLISH = -17, SSL_WRITE_TIMEOUT_ERROR = -18, SSL_READ_TIMEOUT_ERROR = -19, SSL_READ_ERROR = -20, SHADOW_JSON_BUFFER_TRUNCATED = -21, SHADOW_JSON_ERROR = -22, NETWORK_DISCONNECTED = -23, NETWORK_RECONNECT_TIMED_OUT = -24, NETWORK_ATTEMPTING_RECONNECT = -25, NETWORK_ALREADY_CONNECTED = -26, RX_MESSAGE_INVALID = -27, RX_MESSAGE_BIGGER_THAN_MQTT_RX_BUF = -28 } |
| IoT Error enum. More... | |
| enum IoT_Error_t |
IoT Error enum.
Enumeration of return values from the IoT_* functions within the SDK.
| Enumerator | |
|---|---|
| RECONNECT_SUCCESSFUL |
Return value of yield function to indicate auto-reconnect was successful. |
| NONE_ERROR |
Success return value - no error occurred. |
| GENERIC_ERROR |
A generic error. A placeholder for a more specific error. |
| NULL_VALUE_ERROR |
A required parameter was passed as null. |
| CONNECTION_ERROR |
A connection could not be established. |
| SUBSCRIBE_ERROR |
The subscribe failed. A SUBACK was not returned from the service. |
| PUBLISH_ERROR |
The publish failed. In the case of a QoS 1 message a PUBACK was not received. |
| DISCONNECT_ERROR |
The disconnect failed. The disconnect control packet could not be sent. |
| YIELD_ERROR |
An error occurred when yielding to the IoT MQTT client. A possible cause is an unexpected TCP socket disconnect. |
| TCP_CONNECT_ERROR |
The TCP socket could not be established. |
| SSL_CONNECT_ERROR |
The TLS handshake failed. |
| TCP_SETUP_ERROR |
Error associated with setting up the parameters of a Socket. |
| SSL_CONNECT_TIMEOUT_ERROR |
A timeout occurred while waiting for the TLS handshake to complete. |
| SSL_WRITE_ERROR |
A Generic write error based on the platform used. |
| SSL_INIT_ERROR |
SSL initialization error at the TLS layer. |
| SSL_CERT_ERROR |
An error occurred when loading the certificates. The certificates could not be located or are incorrectly formatted. |
| UNSUBSCRIBE_ERROR |
The unsubscribe failed. The unsubscribe control packet could not be sent. |
| JSON_PARSE_ERROR |
An error occurred while parsing the JSON string. Usually malformed JSON. |
| WAIT_FOR_PUBLISH |
Shadow: The response Ack table is currently full waiting for previously published updates. |
| SSL_WRITE_TIMEOUT_ERROR |
SSL Write times out. |
| SSL_READ_TIMEOUT_ERROR |
SSL Read times out. |
| SSL_READ_ERROR |
A Generic error based on the platform used. |
| SHADOW_JSON_BUFFER_TRUNCATED |
Any time an snprintf writes more than size value, this error will be returned. |
| SHADOW_JSON_ERROR |
Any time an snprintf encounters an encoding error or not enough space in the given buffer. |
| NETWORK_DISCONNECTED |
Returned when the Network is disconnected and reconnect is either disabled or physical layer is disconnected. |
| NETWORK_RECONNECT_TIMED_OUT |
Returned when the Network is disconnected and the reconnect attempt has timed out. |
| NETWORK_ATTEMPTING_RECONNECT |
Returned when the Network is disconnected and the reconnect attempt is in progress. |
| NETWORK_ALREADY_CONNECTED |
Returned when the Network is already connected and a connection attempt is made. |
| RX_MESSAGE_INVALID |
The MQTT RX buffer received corrupt message. |
| RX_MESSAGE_BIGGER_THAN_MQTT_RX_BUF |
The MQTT RX buffer received a bigger message. The message will be dropped |
1.8.5