远程隧道的开关的实现文件，实现mqtt消息的订阅及解析更多...

#include <stdint.h>

aiot_tunnel_switch_api.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

类
struct	aiot_tunnel_switch_recv_data_t

类型定义
typedef void(*	aiot_tunnel_switch_recv_handler_t) (void handle, const aiot_tunnel_switch_recv_data_t recv, void *userdata)
	tunnel_swtich模块消息接收回调函数的函数原型定义, 当模块接收到服务器下行数据后将调用此回调函数, 并将消息数据通过recv参数输入给用户, 同时将用户上下文数据指针通过userdata参数返回给用户更多...

枚举
enum	aiot_tunnel_switch_operation_t { AIOT_TUNNEL_OPERATOPN_CLOSE, AIOT_TUNNEL_OPERATOPN_OPEN, AIOT_TUNNEL_OPERATOPN_UPDATE }

enum	aiot_tunnel_switch_option_t { AIOT_TSOPT_MQTT_HANDLE, AIOT_TSOPT_RECV_HANDLER, AIOT_TSOPT_USERDATA, AIOT_TSOPT_MAX }

函数
void *	aiot_tunnel_switch_init ()
	初始化tunnel_switch实例更多...

int32_t	aiot_tunnel_switch_setopt (void handle, aiot_tunnel_switch_option_t option, void data)
	设置tunnel_switch参数更多...

int32_t	aiot_tunnel_switch_deinit (void **handle)
	销毁tunnel_switch实例, 释放资源更多...

int32_t	aiot_tunnel_switch_request (void *handle)
	发送获取隧道信息更多...

详细描述

远程隧道的开关的实现文件，实现mqtt消息的订阅及解析

日期: 2019-12-27

版权所有: Copyright (C) 2015-2018 Alibaba Group Holding Limited

类型定义说明

typedef void(* aiot_tunnel_switch_recv_handler_t) (void *handle, const aiot_tunnel_switch_recv_data_t *recv, void *userdata)

tunnel_swtich模块消息接收回调函数的函数原型定义, 当模块接收到服务器下行数据后将调用此回调函数, 并将消息数据通过recv参数输入给用户,
同时将用户上下文数据指针通过userdata参数返回给用户

参数

[in]	handle	tunnel_switch实例句柄
[in]	recv	服务下发的消息数据, 消息结构体中的所有数据指针在离开回调函数后将失效, 保存消息数据必须使用内存复制的方式
[in]	userdata	指向用户上下文数据的指针, 这个指针由用户通过调用aiot_tunnel_switch_option_t 配置AIOT_TSOPT_USERDATA 选项设置

返回: void

枚举类型说明

enum aiot_tunnel_switch_operation_t

枚举值
AIOT_TUNNEL_OPERATOPN_CLOSE	关闭隧道连接
AIOT_TUNNEL_OPERATOPN_OPEN	打开隧道连接
AIOT_TUNNEL_OPERATOPN_UPDATE	更新隧道连接信息

enum aiot_tunnel_switch_option_t

枚举值
AIOT_TSOPT_MQTT_HANDLE	模块依赖的MQTT句柄 tunnel_switch模块依赖底层的MQTT模块, 用户必需配置正确的MQTT句柄, 否则无法正常工作数据类型: (void *)
AIOT_TSOPT_RECV_HANDLER	数据接收回调函数, tunnel_switch接收物联网平台的下行消息后调用此回调函数数据类型: (aiot_tunnel_switch_recv_handler_t), 详细查看aiot_tunnel_switch_recv_handler_t 回调函数原型
AIOT_TSOPT_USERDATA	指向用户上下文数据的指针在用户注册的aiot_tunnel_switch_recv_handler_t 数据接收回调函数中会同过userdata参数将此指针返回给用户数据类型: (void *)
AIOT_TSOPT_MAX	配置选项数量最大值, 不可用作配置参数

函数说明

void* aiot_tunnel_switch_init ( )

初始化tunnel_switch实例

返回: void*

返回值

非NULL	tunnel_switch实例句柄
NULL	初始化失败, 一般是内存分配失败导致

函数调用图:

int32_t aiot_tunnel_switch_setopt	(	void *	handle,
		aiot_tunnel_switch_option_t	option,
		void *	data
	)

设置tunnel_switch参数

参数

[in]	handle	tunnel_switch实例句柄
[in]	option	配置选项, 更多信息请查看aiot_tunnel_switch_option_t
[in]	data	配置数据, 更多信息请查看aiot_tunnel_switch_option_t

返回: int32_t

返回值

STATE_SUCCESS	参数配置成功
others	参考aiot_state_api.h

函数调用图:

int32_t aiot_tunnel_switch_deinit ( void ** handle )

销毁tunnel_switch实例, 释放资源

参数

[in] handle 指向tunnel_switch实例句柄的指针

返回: int32_t

返回值

STATE_SUCCESS	执行成功
<STATE_SUCCESS	执行失败

函数调用图:

int32_t aiot_tunnel_switch_request ( void * handle )

发送获取隧道信息

参数

[in] handle 指向tunnel_switch实例句柄

返回: int32_t

返回值

STATE_SUCCESS	执行成功
<STATE_SUCCESS	执行失败

函数调用图: