Link Kit C-SDK  5.0.0
结构体 | 类型定义 | 枚举 | 函数
aiot_tunnel_switch_api.h 文件参考

设备的隧道开关模块头文件,提供主动请求隧道、监听物联网平台操作隧道的指令的能力。 更多...

#include <stdint.h>

浏览源代码.

结构体

struct  aiot_ts_msg_t
 隧道开关消息的结构体 更多...
 

类型定义

typedef void(* ts_callback_t) (void *device, const aiot_ts_msg_t *recv, void *userdata)
 设备隧道开关模块消息回调函数原型,用户定义后, 可通过 aiot_device_ts_set_callback 配置 更多...
 

枚举

enum  aiot_ts_ops_t { AIOT_TUNNEL_OPERATOPN_CLOSE, AIOT_TUNNEL_OPERATOPN_OPEN, AIOT_TUNNEL_OPERATOPN_UPDATE }
 隧道开关模块,物联网平台下发隧道操作类型 更多...
 

函数

int32_t aiot_device_ts_set_callback (void *device, ts_callback_t callback, void *userdata)
 设置远程配置 更多...
 
int32_t aiot_device_ts_request (void *device)
 请求默认的远程登录隧道建连信息 更多...
 
aiot_ts_msg_taiot_ts_msg_clone (const aiot_ts_msg_t *msg)
 拷贝隧道的消息 更多...
 
void aiot_ts_msg_free (const aiot_ts_msg_t *msg)
 释放隧道的消息资源 更多...
 

详细描述

设备的隧道开关模块头文件,提供主动请求隧道、监听物联网平台操作隧道的指令的能力。

日期
2022-01-20

类型定义说明

typedef void(* ts_callback_t) (void *device, const aiot_ts_msg_t *recv, void *userdata)

设备隧道开关模块消息回调函数原型,用户定义后, 可通过 aiot_device_ts_set_callback 配置

参数
[in]device设备句柄
[in]recv接收到的消息 aiot_ts_msg_t
[in]userdata用户设置的上下文,可通过 aiot_device_ts_set_callback 配置

枚举类型说明

隧道开关模块,物联网平台下发隧道操作类型

枚举值
AIOT_TUNNEL_OPERATOPN_CLOSE 

关闭隧道连接

AIOT_TUNNEL_OPERATOPN_OPEN 

打开隧道连接

AIOT_TUNNEL_OPERATOPN_UPDATE 

更新隧道连接信息, 发生在设备主动请求默认的远程登录隧道信息。

函数说明

int32_t aiot_device_ts_set_callback ( void *  device,
ts_callback_t  callback,
void *  userdata 
)

设置远程配置

参数
[in]device设备句柄
[in]callback消息回调函数
[in]userdata执行回调消息的上下文
返回
int32_t
返回值
STATE_SUCCESS参数配置成功
STATE_USER_INPUT_NULL_POINTER入参为空
others参考aiot_state_api.h
int32_t aiot_device_ts_request ( void *  device)

请求默认的远程登录隧道建连信息

参数
[in]device设备句柄
返回
int32_t
返回值
>=STATE_SUCCESS发送请求成功
STATE_USER_INPUT_NULL_POINTER入参为空
others参考aiot_state_api.h
aiot_ts_msg_t* aiot_ts_msg_clone ( const aiot_ts_msg_t msg)

拷贝隧道的消息

参数
[in]msg拷贝的消息
返回
aiot_ts_msg_t *
返回值
非空拷贝成功,返回拷贝的消息
void aiot_ts_msg_free ( const aiot_ts_msg_t msg)

释放隧道的消息资源

参数
[in]msg待释放的消息