Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matsune/swift-mqtt
MQTT client for Swift using SwiftNIO
https://github.com/matsune/swift-mqtt
async mqtt mqtt-client swiftnio
Last synced: 3 months ago
JSON representation
MQTT client for Swift using SwiftNIO
- Host: GitHub
- URL: https://github.com/matsune/swift-mqtt
- Owner: matsune
- License: mit
- Created: 2020-08-16T10:50:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-13T07:01:50.000Z (over 3 years ago)
- Last Synced: 2024-04-04T17:33:38.843Z (7 months ago)
- Topics: async, mqtt, mqtt-client, swiftnio
- Language: Swift
- Homepage:
- Size: 95.7 KB
- Stars: 34
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# swift-mqtt
Asynchronous MQTT client library using [SwiftNIO](https://github.com/apple/swift-nio) for networking layer.
- Based on [MQTT Version 3.1.1 Specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718028).
- Supports SSL/TLS connection
## Usage
Create an instance of `MQTTClient` with parameters for connection.
```swift
let client = MQTTClient(
host: "localhost",
port: 1883,
clientID: "swift-mqtt client",
cleanSession: true,
keepAlive: 30,
willMessage: PublishMessage(topic: "will", payload: "will msg", retain: false, qos: .atMostOnce),
)
client.connect()
```
You can handle events with delegate methods.
```swift
client.delegate = self
...
// MQTTClientDelegate
func mqttClient(_ client: MQTTClient, didReceive packet: MQTTPacket) {
...
}
func mqttClient(_ client: MQTTClient, didChange state: ConnectionState) {
...
}
func mqttClient(_ client: MQTTClient, didCatchError error: Error) {
...
}
```
### Publish
```swift
client.publish(topic: "topic", retain: false, qos: QOS.0, payload: "payload")
```
### Subscribe
```swift
client.subscribe(topic: "topic", qos: QOS.0)
```
### Unsubscribe
```swift
client.unsubscribe(topic: "topic")
```
### Disconnect
```swift
client.disconnect()
```
## SSL/TLS connection
This library uses [SwiftNIO SSL](https://github.com/apple/swift-nio-ssl) for SSL connection. You can configure settings of a client.
```swift
let caCert = "./server/certs/ca/ca_cert.pem"
let clientCert = "./server/certs/client/client_cert.pem"
let keyCert = "./server/certs/client/private/client_key.pem"
let tlsConfiguration = try? TLSConfiguration.forClient(
minimumTLSVersion: .tlsv11,
maximumTLSVersion: .tlsv12,
certificateVerification: .noHostnameVerification,
trustRoots: NIOSSLTrustRoots.certificates(NIOSSLCertificate.fromPEMFile(caCert)),
certificateChain: NIOSSLCertificate.fromPEMFile(clientCert).map { .certificate($0) },
privateKey: .privateKey(.init(file: keyCert, format: .pem))
)
client.tlsConfiguration = tlsConfiguration
```