Link Kit C-SDK  4.0.0
aiot_bootstrap_api.h
浏览该文件的文档.
1 
9 #ifndef _AIOT_BOOTSTRAP_API_H_
10 #define _AIOT_BOOTSTRAP_API_H_
11 
12 #if defined(__cplusplus)
13 extern "C" {
14 #endif
15 
16 #include <stdint.h>
17 
21 #define STATE_BOOTSTRAP_BASE (-0x0700)
22 
26 #define STATE_BOOTSTRAP_DEINIT_TIMEOUT (-0x0701)
27 
31 #define STATE_BOOTSTRAP_NEED_SEND_REQUEST (-0x0702)
32 
36 #define STATE_BOOTSTRAP_INVALID_STATUS_CODE (-0x0703)
37 
41 #define STATE_BOOTSTRAP_INVALID_CONNECTION_INFO (-0x0704)
42 
50 typedef enum {
64 
68 typedef struct {
72  aiot_bootstrap_recv_type_t type;
76  union {
80  struct {
81  uint32_t code;
82  } status_code;
86  struct {
87  char *host;
88  uint16_t port;
89  } connection_info;
90  struct {
91  uint32_t cmd;
92  } notify;
93  } data;
95 
105 typedef void (*aiot_bootstrap_recv_handler_t)(void *handle, const aiot_bootstrap_recv_t *packet, void *userdata);
106 
110 typedef enum {
120 
124 typedef struct {
129  aiot_bootstrap_event_type_t type;
131 
140 typedef void (*aiot_bootstrap_event_handler_t)(void *handle, const aiot_bootstrap_event_t *event, void *userdata);
141 
142 typedef enum {
151 
164 
179 
192 
201 
210 
233 
242 
251 
261 
270 
281 
290 
305 
314 void *aiot_bootstrap_init(void);
315 
328 int32_t aiot_bootstrap_setopt(void *handle, aiot_bootstrap_option_t option, void *data);
329 
340 int32_t aiot_bootstrap_deinit(void **handle);
341 
351 int32_t aiot_bootstrap_send_request(void *handle);
352 
362 int32_t aiot_bootstrap_recv(void *handle);
363 
364 #if defined(__cplusplus)
365 }
366 #endif
367 
368 #endif
369 
bootstrap 服务器的域名地址或者ip地址
Definition: aiot_bootstrap_api.h:178
用户需要SDK暂存的上下文
Definition: aiot_bootstrap_api.h:280
bootstrap 服务器返回的http status code
Definition: aiot_bootstrap_api.h:54
收到的bootstrap应答中字段不合法
Definition: aiot_bootstrap_api.h:114
aiot_bootstrap_option_t
Definition: aiot_bootstrap_api.h:142
uint32_t cmd
Definition: aiot_bootstrap_api.h:91
void(* aiot_bootstrap_event_handler_t)(void *handle, const aiot_bootstrap_event_t *event, void *userdata)
bootstrap事件回调函数
Definition: aiot_bootstrap_api.h:140
aiot_bootstrap_recv_type_t type
bootstrap报文类型, 更多信息请参考aiot_bootstrap_recv_type_t
Definition: aiot_bootstrap_api.h:72
bootstrap 服务器的端口号
Definition: aiot_bootstrap_api.h:191
char * host
Definition: aiot_bootstrap_api.h:87
bootstrap会话需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
Definition: aiot_bootstrap_api.h:150
等待bootstrap应答的超时时间
Definition: aiot_bootstrap_api.h:289
设备的device name, 可从阿里云物联网平台控制台获取
Definition: aiot_bootstrap_api.h:209
int32_t aiot_bootstrap_setopt(void *handle, aiot_bootstrap_option_t option, void *data)
设置bootstrap参数
Definition: aiot_bootstrap_api.c:351
配置设备所在的regionId
Definition: aiot_bootstrap_api.h:232
bootstrap接收到的数据
Definition: aiot_bootstrap_api.h:68
Definition: aiot_bootstrap_api.h:303
int32_t aiot_bootstrap_send_request(void *handle)
向bootstrap服务器发送请求
Definition: aiot_bootstrap_api.c:531
bootstrap内部发生的事件会从此回调函数进行通知
Definition: aiot_bootstrap_api.h:269
设备的product key, 可从阿里云物联网平台控制台获取
Definition: aiot_bootstrap_api.h:200
bootstrap会话接收消息时可消费的最长时间间隔
Definition: aiot_bootstrap_api.h:250
aiot_bootstrap_event_type_t type
bootstrap内部事件类型. 更多信息请参考aiot_bootstrap_event_type_t
Definition: aiot_bootstrap_api.h:129
void * aiot_bootstrap_init(void)
初始化bootstrap实例并设置默认参数
Definition: aiot_bootstrap_api.c:309
物联网平台连接信息, 包含域名和端口号
Definition: aiot_bootstrap_api.h:58
int32_t aiot_bootstrap_deinit(void **handle)
释放bootstrap实例句柄的资源
Definition: aiot_bootstrap_api.c:457
收到的bootstrap应答中cmd字段格式错误
Definition: aiot_bootstrap_api.h:118
aiot_bootstrap_recv_type_t
bootstrap报文类型
Definition: aiot_bootstrap_api.h:50
销毁Bootstrap实例时, 等待其他api执行完毕的时间
Definition: aiot_bootstrap_api.h:302
aiot_bootstrap_event_type_t
bootstrap内部事件类型
Definition: aiot_bootstrap_api.h:110
bootstrap 服务器建联时, 网络使用的安全凭据
Definition: aiot_bootstrap_api.h:163
uint32_t code
Definition: aiot_bootstrap_api.h:81
bootstrap会话发送消息时可消费的最长时间间隔
Definition: aiot_bootstrap_api.h:241
int32_t aiot_bootstrap_recv(void *handle)
从bootstrap服务器接收应答
Definition: aiot_bootstrap_api.c:624
uint16_t port
Definition: aiot_bootstrap_api.h:88
bootstrap内部事件
Definition: aiot_bootstrap_api.h:124
void(* aiot_bootstrap_recv_handler_t)(void *handle, const aiot_bootstrap_recv_t *packet, void *userdata)
bootstrap数据接收回调函数原型
Definition: aiot_bootstrap_api.h:105
bootstrap通知信息
Definition: aiot_bootstrap_api.h:62
从 bootstrap 服务器收取的数据从此回调函数进行通知
Definition: aiot_bootstrap_api.h:260