阿里云物联网 .NET Core 客户端 | CZGL.AliIoTClient:2. IoT 客户端
文档目录:
1) 客户端连接
CZGL.AliIoTClient 中,有两个连接到阿里云物联网服务器的方法:
public CZGL.AliIoTClient.ConnectCode ConnectIoT(string[] SubTopic,
[byte[] QOS = null],
[ushort keepAlivePeriod = 60])
public System.Threading.Tasks.Task<CZGL.AliIoTClient.ConnectCode>
ConnectIoTAsync(string[] topics,
[byte[] QOS = null],
[ushort keepAlivePeriod = 60])
参数说明及返回值:
参数名称 | 类型 | 说明 |
---|---|---|
SubTopic | string[] | 要订阅的 Topic 列表,只有先订阅这个 Topic ,才会接收到服务器推送这个 Topic |
QOS | byte[] | 每个Topic都配置一个QOS,如果为空,将会为每个Topic设置 QOS=0x00,注意QOS只有0,1,2三种,因此使用byte最合适 |
keepAlivePeriod | ushort | 存活监测周期,MQTT 通讯要求每间隔一段时间,客户端及时反馈,以此证明客户端的存活,超过这个周期,服务器会认为客户端已经掉线。 |
返回值 | ConnectCode | 是连接返回状态的代码,枚举类型,即使因为密钥错误、网络断开等造成连接失败,不会触发异常,会返回状态码 |
每个 Topic 都有 一个 QOS 属性,SubTopic 的 长度和 QOS 的长度应当一致,索引位置也要对应。
QOS 的含义:
- QOS = 0 ,最多一次
- QOS = 1,至少一次
- QOS = 2,只有一次
ConnectCode:
当客户端尝试与服务器建立连接,可能成功也可能失败,此时会返回具体的连接状态信息,ConnectCode 枚举如下:
枚举名称 | 枚举值 | 说明 |
---|---|---|
conn_accepted | 0x00 | 连接成功 |
conn_refused_prot_vers | 0x01 | 协议版本 |
conn_refused_ident_rejected | 0x02 | 认证被拒绝 |
conn_refused_server_unavailable | x03 | 服务器403/404等 |
conn_refused_username_password | 0x04 | 账号密码错误 |
conn_refused_not_authorized | 0x05 | 没有授权 |
unknown_error | 0x06 | 其它未知错误 |
示例:
var code = client.ConnectIoT(topics, null, 60);
Console.WriteLine("连接状态:" + code);
2)断开连接
public bool ConnectIoTClose()
断开连接,会彻底释放 AliIoTClientJson 对象,而不仅仅是离线,如需重新连接,请重新 new 一个对象;
示例:
client.ConnectIoT(topics,null,60);
3) 查看状态
查看客户端是否与服务器保持连接:
public bool isConnected { get; }
示例:
Console.WriteLine("是否与服务器连接保持连接:" + client.isConnected);
痴者工良(https://whuanle.cn)