boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-07-29 12:07:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

CI: update Codecov action to v5

Browse Source 
Reviewers: korina

Reviewed By: korina

Subscribers: miljen

Differential Revision: https://repo.mireo.local/D33801
This commit is contained in:
Bruno Iljazovic
2025-02-18 11:58:37 +01:00
parent 3dfe07546f
commit 43845343a2
5 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/workflows/coverage.yml vendored
View File

@ -46,7 +46,7 @@ jobs:
apt-get update apt-get update
apt-get -y install --no-install-recommends \ apt-get -y install --no-install-recommends \
sudo git g++ cmake make openssl libssl-dev ca-certificates pkg-config \ sudo git g++ cmake make openssl libssl-dev ca-certificates pkg-config \
python3 lcov gpg gpg-agent python3 lcov gpg gpg-agent curl
- name: Install compiler - name: Install compiler
run: sudo apt-get install -y ${{ matrix.install }} run: sudo apt-get install -y ${{ matrix.install }}
@ -75,11 +75,10 @@ jobs:
lcov --extract coverage.info '**/boost/mqtt5/*' --output-file coverage.info lcov --extract coverage.info '**/boost/mqtt5/*' --output-file coverage.info
- name: Upload coverage reports to Codecov - name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4 uses: codecov/codecov-action@v5
with: with:
verbose: true verbose: true
file: coverage.info files: coverage.info
disable_search: true disable_search: true
fail_ci_if_error: true fail_ci_if_error: true
plugin: noop plugins: noop
token: ${{ secrets.CODECOV_TOKEN }}

8
README.md
View File

@ -3,8 +3,8 @@ Boost.MQTT5: A C++17 MQTT client based on Boost.Asio
Branch | Linux Build | Windows Build | Coverage | Documentation | Branch | Linux Build | Windows Build | Coverage | Documentation |
-------|-------------|---------------|----------|---------------| -------|-------------|---------------|----------|---------------|
[`master`](https://github.com/boostorg/mqtt5/tree/master) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml/badge.svg?branch=master)](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml/badge.svg?branch=master)](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml) | [![codecov](https://codecov.io/gh/mireo/async-mqtt5/branch/master/graph/badge.svg)](https://codecov.io/gh/mireo/async-mqtt5/tree/master) | [documentation](https://www.boost.org/doc/libs/master/libs/mqtt5/doc/html/index.html) [`master`](https://github.com/boostorg/mqtt5/tree/master) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml/badge.svg?branch=master)](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml/badge.svg?branch=master)](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml) | [![codecov](https://codecov.io/gh/boostorg/mqtt5/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/mqtt5/tree/master) | [documentation](https://www.boost.org/doc/libs/master/libs/mqtt5/doc/html/index.html)
[`develop`](https://github.com/boostorg/mqtt5/tree/develop) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml/badge.svg?branch=develop)](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml/badge.svg?branch=develop)](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml) | [![codecov](https://codecov.io/gh/mireo/async-mqtt5/branch/develop/graph/badge.svg)](https://codecov.io/gh/mireo/async-mqtt5/tree/develop) | [documentation](https://www.boost.org/doc/libs/develop/libs/mqtt5/doc/html/index.html) [`develop`](https://github.com/boostorg/mqtt5/tree/develop) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml/badge.svg?branch=develop)](https://github.com/boostorg/mqtt5/actions/workflows/ci-posix.yml) | [![build status](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml/badge.svg?branch=develop)](https://github.com/boostorg/mqtt5/actions/workflows/ci-windows.yml) | [![codecov](https://codecov.io/gh/boostorg/mqtt5/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/mqtt5/tree/develop) | [documentation](https://www.boost.org/doc/libs/develop/libs/mqtt5/doc/html/index.html)
Boost.MQTT5 is a professional, industrial-grade C++17 client built on [Boost.Asio](https://www.boost.org/doc/libs/master/doc/html/boost_asio.html). This Client is designed for publishing or receiving messages from an MQTT 5.0 compatible Broker. Boost.MQTT5 represents a comprehensive implementation of the MQTT 5.0 protocol standard, offering full support for publishing or receiving messages with QoS 0, 1, and 2. Boost.MQTT5 is a professional, industrial-grade C++17 client built on [Boost.Asio](https://www.boost.org/doc/libs/master/doc/html/boost_asio.html). This Client is designed for publishing or receiving messages from an MQTT 5.0 compatible Broker. Boost.MQTT5 represents a comprehensive implementation of the MQTT 5.0 protocol standard, offering full support for publishing or receiving messages with QoS 0, 1, and 2.
@ -39,7 +39,7 @@ The library attempts to embody this belief with a range of key features designed
Feature | Description | Feature | Description |
--------|-------------| --------|-------------|
**Complete TCP, TLS/SSL, and WebSocket support** | The MQTT protocol requires an underlying network protocol that provides ordered, lossless, bi-directional connection (stream). Users can customize this stream through a template parameter. The Boost.MQTT5 library has been tested with the most used transport protocols: TCP/IP using `boost::asio::ip::tcp::socket`, TLS/SSL using `boost::asio::ssl::stream`, WebSocket/TCP and WebSocket/TLS using `boost::beast::websocket::stream`). | **Complete TCP, TLS/SSL, and WebSocket support** | The MQTT protocol requires an underlying network protocol that provides ordered, lossless, bi-directional connection (stream). Users can customize this stream through a template parameter. The Boost.MQTT5 library has been tested with the most used transport protocols: TCP/IP using `boost::asio::ip::tcp::socket`, TLS/SSL using `boost::asio::ssl::stream`, WebSocket/TCP and WebSocket/TLS using `boost::beast::websocket::stream`). |
**Automatic reconnect and retry mechanism** | Automatically handles connection loss, backoffs, reconnections, and message transmissions. Automating these processes enables users to focus entirely on the application's functionality. See [Built-in Auto-Reconnect and Retry Mechanism](https://spacetime.mireo.com/async-mqtt5/async_mqtt5/auto_reconnect.html). | **Automatic reconnect and retry mechanism** | Automatically handles connection loss, backoffs, reconnections, and message transmissions. Automating these processes enables users to focus entirely on the application's functionality. See [Built-in Auto-Reconnect and Retry Mechanism](https://www.boost.org/doc/libs/master/libs/mqtt5/doc/html/mqtt5/auto_reconnect.html). |
**Prioritised efficiency** | Utilises network and memory resources as efficiently as possible. | **Prioritised efficiency** | Utilises network and memory resources as efficiently as possible. |
**Minimal memory footprint** | Ensures optimal performance in resource-constrained environments typical of IoT devices. | **Minimal memory footprint** | Ensures optimal performance in resource-constrained environments typical of IoT devices. |
**Completion token** | All asynchronous functions are implemented using Boost.Asio's universal asynchronous model and support CompletionToken. This allows versatile usage with callbacks, coroutines, and futures. | **Completion token** | All asynchronous functions are implemented using Boost.Asio's universal asynchronous model and support CompletionToken. This allows versatile usage with callbacks, coroutines, and futures. |
@ -111,7 +111,7 @@ int main() {
ioc.run(); ioc.run();
} }
``` ```
To see more examples, visit [Examples](https://github.com/mireo/async-mqtt5/tree/master/example). To see more examples, visit [Examples](https://github.com/boostorg/mqtt5/tree/master/example).
Contributing Contributing
--------- ---------

2
doc/qbk/00_main.qbk
View File

@ -75,7 +75,7 @@
[/ MQTT ] [/ MQTT ]
[def __MQTT__ [@https://mqtt.org/ MQTT]] [def __MQTT__ [@https://mqtt.org/ MQTT]]
[def __Self__ [@https://github.com/mireo/async-mqtt5/ Boost.MQTT5]] [def __Self__ [@https://github.com/boostorg/mqtt5/ Boost.MQTT5]]
[def __Client__ [reflink2 mqtt_client `mqtt_client`]] [def __Client__ [reflink2 mqtt_client `mqtt_client`]]
[def __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]] [def __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]]

2
doc/qbk/02_getting_started.qbk
View File

@ -100,7 +100,7 @@ and `jitter` is a randomly chosen value between `-500ms` to `500ms`, intended to
[section:using_the_client Using the Client] [section:using_the_client Using the Client]
After calling [refmem mqtt_client async_run], you can now use the Client according to your application needs. After calling [refmem mqtt_client async_run], you can now use the Client according to your application needs.
In this case, we will publish a "Hello World!" message to `async-mqtt5/test` topic with Quality of Service 0 (at most once) using the [refmem mqtt_client async_publish] function. In this case, we will publish a "Hello World!" message to `boost-mqtt5/test` topic with Quality of Service 0 (at most once) using the [refmem mqtt_client async_publish] function.
[publish_hello_world] [publish_hello_world]

2
example/CMakeLists.txt
View File

@ -7,7 +7,7 @@
cmake_minimum_required(VERSION 3.8...3.20) cmake_minimum_required(VERSION 3.8...3.20)
project(async-mqtt5-examples LANGUAGES CXX) project(boost-mqtt5-examples LANGUAGES CXX)
function(add_example name) function(add_example name)
add_executable("${name}" ${ARGN}) add_executable("${name}" ${ARGN})