artik_cloud.h File Reference
Cloud module definition. More...
#include "artik_error.h"#include "artik_types.h"#include "artik_http.h"#include "artik_websocket.h"Go to the source code of this file.
Data Structures | |
| struct | artik_cloud_module |
| Cloud module operations. More... | |
Macros | |
| #define | MAX_TOKEN_LEN 64 |
| Maximum length for token strings. More... | |
| #define | WEBSOCKET_CONNECTION_TIMEOUT_MS (10*1000) |
Typedefs | |
| typedef void(* | artik_cloud_callback) (artik_error result, char *response, void *user_data) |
| Response callback prototype. More... | |
Variables | |
| const artik_cloud_module | cloud_module |
Detailed Description
Definitions and functions for accessing the Cloud module and communicating with the Artik Cloud over its RESTful API.
Detailed API specifications: https://developer.samsungsami.io/sami/api-spec.html
Definition in file artik_cloud.h.
Macro Definition Documentation
| #define MAX_TOKEN_LEN 64 |
Maximum length allowed for string containing an authorization token for the Artik Cloud API
Definition at line 52 of file artik_cloud.h.
Typedef Documentation
| typedef void(* artik_cloud_callback) (artik_error result, char *response, void *user_data) |
- Parameters
-
[in] result Error returned by the cloud process, S_OK on success, error code otherwise [in] response Pointer to a string filled up with the response JSON data returned by the Cloud. [in] user_data The user data passed from the callback function
Definition at line 65 of file artik_cloud.h.
Last updated on: