mqtt4cj

介绍

MQTT(Message Queuing Telemetry Transport,消息队列遥测传输协议),是一种基于发布/订阅(publish/subscribe)模式的"轻量级"通讯协议,该协议构建于TCP/IP协议上。

特性

  • 🚀 支持 tcp/tls/ws/wss 方式连接消息服务端
  • 🚀 支持 mqttv3 协议连接消息服务端
  • 🚀 支持 mqtt 主题订阅发布

架构

源码目录

.
├── README.md
├── doc
└── src
    └── mqttv3
  • doc存放库的设计文档、提案、库的使用文档
  • src存放库源码目录

接口说明

主要是核心类和成员函数说明,详情见 API

使用说明

编译(win/linux)

两种编译方式

  1. 使用脚本编译
    1. 下载配置编译脚本
    2. ciTest build
  2. 使用cjpm编译
    1. 该三方库依赖stdx,请参考stdx文档配置CANGJIE_STDX_PATH路径
    2. cjpm build

示例

mqtt提供了 同步/异步 客户端
同步客户端内部调用了异步客户端

客户端提供了 连接/发布/订阅/监听 API

构建客户端

创建 mqtt异步客户端

    public func build(): Unit {
        let client1 = MqttAsyncClient.build("tcp://127.0.0.1:1883", "clientId1")
        let client2 = MqttAsyncClient.build("ssl://127.0.0.1:8883", "clientId2")
        let client3 = MqttClient("ws://127.0.0.1:8083/mqtt", "clientId3")
        let client4 = MqttClient("wss://127.0.0.1:8084", "clientId4")

        client4.connect()
        client4.disconnect()
        client4.close()
    }

发布

使用异步客户端发布消息

    public func pub(): Unit {
        let mqttClient: MqttAsyncClient = MqttAsyncClient.build("ws://127.0.0.1:8083/mqtt", "clientId")
        let connectToken = mqttClient.connect().waitForCompletion()

        // 发布 "hello" 到 "topic_89"
        let pubToken: IMqttDeliveryToken = mqttClient.publish("topic_89", "hello".toArray(), 2, false)
        println(pubToken.isComplete()) // true
        println(pubToken.getMessageId()) // 1

        mqttClient.disconnect().waitForCompletion()
        mqttClient.close()
    }

订阅

使用同步客户端订阅消息

class MyMsgListener <: IMqttMessageListener {
    public func messageArrived(topic: String, message: MqttMessage): Unit {
        let msgstr: String = String.fromUtf8(message.getPayload())
        println("${topic} ${msgstr}")
    }
}
    public func sub(): Unit {
        let mqttClient: MqttClient = MqttClient("ws://127.0.0.1:8083/mqtt", "clientId")
        let connectToken = mqttClient.connect()

        // 订阅 "topic_89" 消息由 MyMsgListener 处理
        mqttClient.subscribe("topic_89", MyMsgListener())
        mqttClient.publish("topic_89", "hello".toArray(), 0, false)
        sleep(Duration.second)

        mqttClient.disconnect()
        mqttClient.close()
    }

开源协议

本项目基于 Eclipse Distribution License 1.0 , 请自由享受和参与开源

参与贡献

欢迎给我们提交PR,欢迎给我们提交Issue,欢迎参与任何形式的贡献。