Link Kit C-SDK  4.1.0
aiot_ra_api.h
浏览该文件的文档.
1 
22 #ifndef AIOT_RA_API_H_
23 #define AIOT_RA_API_H_
24 
25 #if defined(__cplusplus)
26 extern "C" {
27 #endif
28 
32 #define STATE_REMOTE_ACCESS_BASE (-0x1C00)
33 
36 #define STATE_REMOTE_ACCESS_FAILED (-0x1C01)
37 
40 #define STATE_REMOTE_ACCESS_TIMEOUT (-0x1C02)
41 
44 #define STATE_REMOTE_ACCESS_RESET (-0x1C03)
45 
48 #define STATE_REMOTE_ACCESS_MISSING_MQTT_HADNL (-0x1C04)
49 
52 #define STATE_REMOTE_ACCESS_SYSTEM_NOT_LINUX (-0x1C0A)
53 
54 
58 typedef enum {
76 
80 typedef struct {
81  aiot_ra_event_type type;
82  char tunnel_id[128];
84 
88 typedef struct {
92  char type[128];
96  char ip[128];
100  unsigned int port;
102 
113 typedef void (*aiot_ra_event_handler_t)(void *handle, const aiot_ra_event_t *event, void *userdata);
114 
115 
133 typedef enum {
158 
183 
192 void *aiot_ra_init(void);
193 
208 int32_t aiot_ra_setopt(void *handle, aiot_ra_option_t option, void *data);
209 
220 int32_t aiot_ra_deinit(void **handle);
221 
231 void* aiot_ra_start(void *handle);
232 
242 int32_t aiot_ra_stop(void *handle);
243 
253 int32_t aiot_ra_request(void *handle);
254 
255 #endif /* __AIOT_RA_API_H_ */
void * aiot_ra_init(void)
创建ra会话实例, 并以默认值配置会话参数
Definition: aiot_ra_api.c:38
RA内部事件
Definition: aiot_ra_api.h:80
void * aiot_ra_start(void *handle)
开始ra服务,作为线程开始运行
Definition: aiot_ra_api.c:180
RA会话 需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
Definition: aiot_ra_api.h:141
用户需要SDK暂存的上下文
Definition: aiot_ra_api.h:157
int32_t aiot_ra_request(void *handle)
主动请求建立通道
Definition: aiot_ra_api.c:213
RA建联时, 网络使用的安全凭据
Definition: aiot_ra_api.h:176
新增本地可提供的远程服务
Definition: aiot_ra_api.h:180
aiot_ra_event_type type
Definition: aiot_ra_api.h:81
unsigned int port
服务端口号
Definition: aiot_ra_api.h:100
int32_t aiot_ra_deinit(void **handle)
结束ra会话, 销毁实例并回收资源
Definition: aiot_ra_api.c:141
aiot_ra_option_t
aiot_mqtt_setopt 函数的option参数. 对于下文每一个选项中的数据类型, 指的是aiot_mqtt_setopt 中的data参...
Definition: aiot_ra_api.h:133
当RA实例从代理通道断开, 触发此事件
Definition: aiot_ra_api.h:66
aiot_ra_event_type
RA内部事件类型
Definition: aiot_ra_api.h:58
接收到topic信息,打开代理通道
Definition: aiot_ra_api.h:70
int32_t aiot_ra_setopt(void *handle, aiot_ra_option_t option, void *data)
配置ra会话
Definition: aiot_ra_api.c:94
Definition: aiot_ra_api.h:181
当RA实例连接代理通道成功, 触发此事件
Definition: aiot_ra_api.h:62
设置内部事件回调, 它在内部事件触发, 告知用户
Definition: aiot_ra_api.h:149
接收到topic信息,关闭代理通道
Definition: aiot_ra_api.h:74
本地服务信息
Definition: aiot_ra_api.h:88
int32_t aiot_ra_stop(void *handle)
停止ra服务,aiot_ra_start线程退出
Definition: aiot_ra_api.c:200
void(* aiot_ra_event_handler_t)(void *handle, const aiot_ra_event_t *event, void *userdata)
RA内部事件回调函数接口定义
Definition: aiot_ra_api.h:113