mqtt-nio - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #go #rust #docker #nodejs #windows #awesome #cli #awesome-list #security #ios #mcp #open-source

mqtt-nio

(★ 244)

A Swift NIO MQTT v3.1.1 and v5.0 Client

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- docker-compose.yml
- - bug_report.md
- - api-breakage.yml
  - ci.yml
  - validate.yml
- dependabot.yml
- FUNDING.yml
- - ca.der
  - ca.key
  - ca.pem
  - ca.srl
  - client.csr
  - client.key
  - client.p12
  - client.pem
  - mosquitto.org.crt
  - server.csr
  - server.key
  - server.pem
- - mosquitto.conf
  - passwd
- - .gitkeep
- generate-certs.sh
- generate_contributors_list.sh
- mosquitto.sh
- openssl.cnf
- validate.sh
- - MQTTCoreTypes.swift
  - MQTTCoreTypesV5.swift
  - MQTTError.swift
  - MQTTPacket.swift
  - MQTTProperties.swift
  - MQTTReason.swift
  - MQTTSerializer.swift
  - TSTLSConfiguration.swift
- - IntegrationTests.swift
  - IntegrationV5Tests.swift
- - ConfigurationTests.swift
  - CoreMQTTTests.swift
  - MQTTConnectionTests.swift
  - MQTTSubscriptionsTests.swift
.dockerignore
.gitignore
.mailmap
.spi.yml
.swift-format
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.txt
docker-compose.yml
LICENSE
Package.swift
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/swift-server-community/mqtt-nio

Downloads the entire project code from GitHub to your computer.

cd mqtt-nio

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MQTT NIO

[![sswg:sandbox|94x20](https://img.shields.io/badge/sswg-sandbox-lightgrey.svg)](https://github.com/swift-server/sswg/blob/master/process/incubation.md#sandbox-level)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fswift-server-community%2Fmqtt-nio%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/swift-server-community/mqtt-nio)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fswift-server-community%2Fmqtt-nio%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/swift-server-community/mqtt-nio)
[<img src="https://github.com/swift-server-community/mqtt-nio/workflows/CI/badge.svg" />](https://github.com/swift-server-community/mqtt-nio/workflows/CI/badge.svg)
![Codecov](https://img.shields.io/codecov/c/github/swift-server-community/mqtt-nio)

A Swift NIO based MQTT v3.1.1 and v5.0 client.

MQTT (Message Queuing Telemetry Transport) is a lightweight messaging protocol that was developed by IBM and first released in 1999. It uses the pub/sub pattern and translates messages between devices, servers, and applications. It is commonly used in Internet of things (IoT) technologies.

MQTTNIO is a Swift NIO based implementation of a MQTT client. It supports:

- MQTT versions 3.1.1 and 5.0
- Unencrypted and encrypted (via TLS) connections
- WebSocket connections
- POSIX and Unix domain sockets
- Apple's Network framework via [NIOTransportServices](https://github.com/apple/swift-nio-transport-services) (required for iOS)
- [Swift Configuration](https://github.com/apple/swift-configuration) to create `MQTTConnectionConfiguration` from a configuration file
- [Task-local loggers](https://swiftpackageindex.com/apple/swift-log/documentation/logging/slg-0006-task-local-logger) from SwiftLog

## Overview

Create a connection to the MQTT broker with `MQTTConnection.withConnection` and use it inside the closure.
When the closure returns the connection will be closed.
`CONNECT` and `DISCONNECT` packets are sent automatically, respectively before and after the closure is executed.

```swift
try await MQTTConnection.withConnection(
    address: .hostname("mqtt.eclipse.org"),
    identifier: "My Client"
) { connection in
    // You are now connected to the MQTT broker
    // The connection will be active only inside this closure
}
```

Subscribe to a topic with `MQTTConnection.subscribe`,
providing a closure that receives an `AsyncSequence` of incoming `PUBLISH` messages sent from the broker to that topic.
When the closure finishes executing, the corresponding `UNSUBSCRIBE` message is automatically sent to the broker, and the subscription is cleaned up.

```swift
let subscribeInfo = MQTTSubscribeInfo(topicFilter: "my-topics", qos: .atLeastOnce)
try await connection.subscribe(to: [subscribeInfo]) { subscription in
    for try await message in subscription {
        var buffer = message.payload
        let string = buffer.readString(length: buffer.readableBytes)
        // No need to filter messages, as only messages for "my-topics" are received here
        print(string)
    }
}
```

Publish to a topic with `MQTTConnection.publish`.

```swift
try await connection.publish(
    to: "my-topics",
    payload: ByteBuffer(string: "This is the Test payload"),
    qos: .atLeastOnce
)
```

## Documentation

User guides and reference documentation for MQTT NIO can be found on the [Swift Package Index](https://swiftpackageindex.com/swift-server-community/mqtt-nio/documentation/mqttnio).
There is also a sample demonstrating the use of MQTTNIO in an iOS app found [here](https://github.com/adam-fowler/EmCuTeeTee).