参数说明

本文用来对 SDK 中的部分常见参数进行综合的解释说明。

topic

topic 用来表示 频道名称频道过滤器

  • topic作为频道名称时,允许的字符包括:英文大小写字母、数字、下划线_和正斜杠/
  • topic作为频道过滤器时,允许的字符包括:英文大小写字母、数字、下划线_、正斜杠/,以及表示通配符的#+

取值范围

  • 下列 API 中的topic可以作为 频道名称频道过滤器取值范围为:英文大小写字母、数字、_/#+,长度不超过 128 个字符。

    • subscribe()(或MQTTClient_subscribe
    • unsubscribe()(或MQTTClient_unsubscribe
    • get_alias_list()(或getAliasList()MQTTGetAliasList()等类似名称)
  • 下列 API 中的topic只能是 频道名称取值范围为:英文大小写字母、数字、_/,长度不超过 128 个字符。

    • publish()(或MQTTClient_publish
    • publish2()(或MQTTClient_publish2
    • subscribe_presence()(或MQTTClient_presence
    • unsubscribe_presence()(或MQTTClient_unpresence
  • topics数组的元素个数不超过 100。

  • /pPresence 的保留字(例如,subscribe("t/p")相当于subscribe_presence("t"))。为了避免混淆,建议避免在topic参数中使用/p字符,如需订阅某频道的 Presence,可直接调用 Presence 相关的 API。

alias

alias 用来表示 别名

注意

  • 同一个 AppKey 下,alias 是唯一的,不能有重复。假设 Client 1 别名为 A;此时如果设置 Client 2 的别名为 A 则 Client 1 的别名将会失效。

  • 设置别名为空字符串,可以取消别名。

取值范围

  • alias的取值范围为:英文(大小写)、数字、下划线_,长度不超过 128 个字符。