-
Generated by
1.8.14
|
AWS IoT Device SDK C:
Shadow
AWS IoT Device Shadow library
|
| Return to main page ↑ |
Enumerated types of the Shadow library. More...
Enumerations | |
| enum | AwsIotShadowError_t { AWS_IOT_SHADOW_SUCCESS = 0, AWS_IOT_SHADOW_STATUS_PENDING = 1, AWS_IOT_SHADOW_INIT_FAILED = 2, AWS_IOT_SHADOW_BAD_PARAMETER = 3, AWS_IOT_SHADOW_NO_MEMORY = 4, AWS_IOT_SHADOW_MQTT_ERROR = 5, AWS_IOT_SHADOW_BAD_RESPONSE = 7, AWS_IOT_SHADOW_TIMEOUT = 8, AWS_IOT_SHADOW_NOT_INITIALIZED = 11, AWS_IOT_SHADOW_BAD_REQUEST = 400, AWS_IOT_SHADOW_UNAUTHORIZED = 401, AWS_IOT_SHADOW_FORBIDDEN = 403, AWS_IOT_SHADOW_NOT_FOUND = 404, AWS_IOT_SHADOW_CONFLICT = 409, AWS_IOT_SHADOW_TOO_LARGE = 413, AWS_IOT_SHADOW_UNSUPPORTED = 415, AWS_IOT_SHADOW_TOO_MANY_REQUESTS = 429, AWS_IOT_SHADOW_SERVER_ERROR = 500 } |
| Return codes of Shadow functions. More... | |
| enum | AwsIotShadowCallbackType_t { AWS_IOT_SHADOW_DELETE_COMPLETE, AWS_IOT_SHADOW_GET_COMPLETE, AWS_IOT_SHADOW_UPDATE_COMPLETE, AWS_IOT_SHADOW_DELTA_CALLBACK, AWS_IOT_SHADOW_UPDATED_CALLBACK } |
| Types of Shadow library callbacks. More... | |
Enumerated types of the Shadow library.
| enum AwsIotShadowError_t |
Return codes of Shadow functions.
The function AwsIotShadow_strerror can be used to get a return code's description.
The values between 400 (AWS_IOT_SHADOW_BAD_REQUEST) and 500 (AWS_IOT_SHADOW_SERVER_ERROR) may be returned by the Shadow service when it rejects a Shadow operation. See this page for more information.
| Enumerator | |
|---|---|
| AWS_IOT_SHADOW_SUCCESS | Shadow operation completed successfully. Functions that may return this value:
Will also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_STATUS_PENDING | Shadow operation queued, awaiting result. Functions that may return this value: |
| AWS_IOT_SHADOW_INIT_FAILED | Initialization failed. Functions that may return this value: |
| AWS_IOT_SHADOW_BAD_PARAMETER | At least one parameter is invalid. Functions that may return this value: |
| AWS_IOT_SHADOW_NO_MEMORY | Shadow operation failed because of memory allocation failure. Functions that may return this value: |
| AWS_IOT_SHADOW_MQTT_ERROR | Shadow operation failed because of failure in MQTT library. Check the Shadow library logs for the error code returned by the MQTT library. Functions that may return this value: |
| AWS_IOT_SHADOW_BAD_RESPONSE | Response received from Shadow service not understood. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_TIMEOUT | A blocking Shadow operation timed out. Functions that may return this value: |
| AWS_IOT_SHADOW_NOT_INITIALIZED | An API function was called before AwsIotShadow_Init. Functions that may return this value: |
| AWS_IOT_SHADOW_BAD_REQUEST | Shadow operation rejected: Bad request. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_UNAUTHORIZED | Shadow operation rejected: Unauthorized. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_FORBIDDEN | Shadow operation rejected: Forbidden. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_NOT_FOUND | Shadow operation rejected: Thing not found. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_CONFLICT | Shadow operation rejected: Version conflict. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_TOO_LARGE | Shadow operation rejected: The payload exceeds the maximum size allowed. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_UNSUPPORTED | Shadow operation rejected: Unsupported document encoding; supported encoding is UTF-8. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_TOO_MANY_REQUESTS | Shadow operation rejected: The Device Shadow service will generate this error message when there are more than 10 in-flight requests. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
| AWS_IOT_SHADOW_SERVER_ERROR | Shadow operation rejected: Internal service failure. Functions that may return this value: May also be the value of a Shadow operation completion callback's |
Types of Shadow library callbacks.
One of these values will be placed in AwsIotShadowCallbackParam_t.callbackType to identify the reason for invoking a callback function.
| Enumerator | |
|---|---|
| AWS_IOT_SHADOW_DELETE_COMPLETE | Callback invoked because a Shadow delete completed. |
| AWS_IOT_SHADOW_GET_COMPLETE | Callback invoked because a Shadow get completed. |
| AWS_IOT_SHADOW_UPDATE_COMPLETE | Callback invoked because a Shadow update completed. |
| AWS_IOT_SHADOW_DELTA_CALLBACK | Callback invoked for an incoming message on a Shadow delta topic. |
| AWS_IOT_SHADOW_UPDATED_CALLBACK | Callback invoked for an incoming message on a Shadow updated topic. |
1.8.14