diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 287ff00..db1f1c0 100644 --- a/.github/workflows/coverage.yml +++ b/.github/workflows/coverage.yml @@ -46,7 +46,7 @@ jobs: apt-get update apt-get -y install --no-install-recommends \ 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 run: sudo apt-get install -y ${{ matrix.install }} @@ -75,11 +75,10 @@ jobs: lcov --extract coverage.info '**/boost/mqtt5/*' --output-file coverage.info - name: Upload coverage reports to Codecov - uses: codecov/codecov-action@v4 + uses: codecov/codecov-action@v5 with: verbose: true - file: coverage.info + files: coverage.info disable_search: true fail_ci_if_error: true - plugin: noop - token: ${{ secrets.CODECOV_TOKEN }} + plugins: noop diff --git a/README.md b/README.md index cb08999..8c99e6f 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ Boost.MQTT5: A C++17 MQTT client based on Boost.Asio 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) -[`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) +[`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/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. @@ -39,7 +39,7 @@ The library attempts to embody this belief with a range of key features designed 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`). | -**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. | **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. | @@ -111,7 +111,7 @@ int main() { 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 --------- diff --git a/doc/qbk/00_main.qbk b/doc/qbk/00_main.qbk index 8f9ca8b..9142a34 100644 --- a/doc/qbk/00_main.qbk +++ b/doc/qbk/00_main.qbk @@ -75,7 +75,7 @@ [/ 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 __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]] diff --git a/doc/qbk/02_getting_started.qbk b/doc/qbk/02_getting_started.qbk index 6bb48b0..a7425df 100644 --- a/doc/qbk/02_getting_started.qbk +++ b/doc/qbk/02_getting_started.qbk @@ -100,7 +100,7 @@ and `jitter` is a randomly chosen value between `-500ms` to `500ms`, intended to [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. -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] diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt index ed343f8..271c44d 100644 --- a/example/CMakeLists.txt +++ b/example/CMakeLists.txt @@ -7,7 +7,7 @@ cmake_minimum_required(VERSION 3.8...3.20) -project(async-mqtt5-examples LANGUAGES CXX) +project(boost-mqtt5-examples LANGUAGES CXX) function(add_example name) add_executable("${name}" ${ARGN})