Skip to content

Commit 165476b

Browse files
committed
Updated the README and CHANGELOG for release v1.5.2. Did some spellchecks.
1 parent 59aa9b4 commit 165476b

File tree

9 files changed

+38
-32
lines changed

9 files changed

+38
-32
lines changed

CHANGELOG.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ All notable changes to this project will be documented in this file.
66

77
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
88

9-
## Upcoming Version 1.5.2 (unreleased)
10-
11-
- Synchronous `Client` constructors updated to use `persistence_type` and (just) `create_options`
12-
- Restored compatiblity with `async_client`
13-
- [#537](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/537) Fixed the Windows DLL build by exporting message::EMPTY_STR and message::EMPTY_BIN
14-
- [#540](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/537) Missing default argument in `async_client` changed constructor breaks code compatibility
9+
## [Version 1.5.2](https://github.com/eclipse/paho.mqtt.cpp/compare/v1.5.1..v1.5.2) (2025-03-11)
1510

11+
- Fixed the Version number and string.
12+
- Synchronous `Client` constructors updated to use `persistence_type` and (just) `create_options`
13+
- Restored compatibility with `async_client`
14+
- [#505](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/505): Example of retrieving MQTT v5 properties in message received callback
15+
- [#537](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/537) Fixed the Windows DLL build by exporting message::EMPTY_STR and message::EMPTY_BIN
16+
- [#540](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/537) Missing default argument in `async_client` changed constructor breaks code compatibility
1617

1718

1819
## [Version 1.5.1](https://github.com/eclipse/paho.mqtt.cpp/compare/v1.5.0..v1.5.1) - (2025-02-09)

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,24 @@ To keep up with the latest announcements for this project, or to ask questions:
3434

3535
### What's New in v1.5.x
3636

37-
The latest updates move the codebase to C++17 and adds supoort for UNIX-domain sockets. They also fixe a number of build issues, and targets the latest Paho C release, v1.3.14.
37+
The latest updates for v1.5 moved the codebase to C++17 and added support for UNIX-domain sockets. They also fixed a number of build issues, now targeting the latest Paho C release, v1.3.14.
3838

39-
- Update the code base to C++17
40-
- Support for the pending Paho C v1.3.14 release.
41-
- Support for UNIX-domain sockets
39+
The primary changes in the v1.5 versions are:
40+
41+
- Updated the code base to C++17
42+
- Support for the Paho C v1.3.14 release.
43+
- Support for UNIX-domain sockets
4244
- Reorganize and reformat the sources and added a .clang-format capability.
4345
- Create universal client instances that can connect using v3 or v5. (i.e. no more instances that are only v3 capable)
4446
- Bump the CMake to v3.13
45-
- Fix a number of CMake build issues
46-
- Update the GitHub CI
47+
- Fix a large number of CMake build issues
48+
- Updated the GitHub CI
49+
50+
For the full list of updates in each release, see the [CHANGELOG](https://github.com/eclipse-paho/paho.mqtt.cpp/blob/master/CHANGELOG.md).
4751

4852
## Contributing
4953

50-
Contributions to this project are gladly welcomed and appreciated Before submitting a Pull Request, please keep three things in mind:
54+
Contributions to this project are gladly welcomed and appreciated. Before submitting a Pull Request, please keep three things in mind:
5155

5256
- This is an official Eclipse project, so it is required that all contributors sign an [Eclipse Contributor Agreement (ECA)](https://www.eclipse.org/legal/ECA.php)
5357
- Please submit all Pull Requests against the _develop_ branch (not master).
@@ -57,17 +61,17 @@ Contributions to this project are gladly welcomed and appreciated Before submitt
5761

5862
## Building from source
5963

60-
As of v1.5, the Paho C++ library uses C++17 features, and thus requires a fully compliant C++17 compiler. Some of the more common options, depending on the target platform, are:
64+
As of v1.5, the Paho C++ library uses C++17 features, thus requiring a fully compliant C++17 compiler. Some of the more common compilers that can be used, depending on the target platform, are:
6165

6266
* GCC v8 or later
6367
* _clang_ v5 or later
6468
* Visual Studio 2017 15.8 (MSVC 19.15) or later
6569

66-
_CMake_ is a cross-platform build system suitable for Unix and non-Unix platforms such as Microsoft Windows. It is now the only supported build system. The current supported minimum version is:
70+
_CMake_ is a cross-platform build system suitable for Unix and non-Unix platforms such as Microsoft Windows. It is the only supported build system. The current supported minimum version is:
6771

6872
* cmake v3.13
6973

70-
The Paho C++ library requires the Paho C library, v1.3.14 or greater, to be built and installed. That can be done before building this library, or it can be done here using the CMake `PAHO_WITH_MQTT_C` build option to build both libraries at the same time. This also guarantees that a proper version of the C library is used, and that it is build with compatible options.
74+
The Paho C++ library requires the Paho C library, v1.3.14 or greater to be built and installed. That can be done before building this library, or it can be done here using the CMake `PAHO_WITH_MQTT_C` build option to build both libraries at the same time. This also guarantees that a proper version of the C library is used, and that it is build with compatible options.
7175

7276
### Build Options
7377

@@ -84,19 +88,19 @@ PAHO_BUILD_TESTS | FALSE | Build the unit tests. (Requires _Catch2_)
8488
PAHO_BUILD_DEB_PACKAGE | FALSE | Flag that configures cpack to build a Debian/Ubuntu package
8589
PAHO_WITH_MQTT_C | FALSE | Whether to build the bundled Paho C library
8690

87-
Enabling `PAHO_WITH_MQTT_C` builds and links in the Paho C library using compatible build options. If this is enabled, it passes the `PAHO_WITH_SSL` option to the C library, and also sets the options `PAHO_HIGH_PERFORMACE` and `PAHO_WITH_UNIX_SOCKETS` for the C lib. These can be disabled in the cache before building if desired.
91+
Enabling `PAHO_WITH_MQTT_C` builds and links in the Paho C library using compatible build options. If this is enabled, it passes the `PAHO_WITH_SSL` option to the C library, and also sets the options `PAHO_HIGH_PERFORMANCE` and `PAHO_WITH_UNIX_SOCKETS` for the C lib. These can be disabled in the cache before building if desired.
8892

8993
In addition, the C++ build might commonly use `CMAKE_PREFIX_PATH` to help the build system find the location of the Paho C library if it was built separately.
9094

9195
### Build the Paho C++ and Paho C libraries together
9296

93-
The quickest and easiest way to build Paho C++ is to buid it together with Paho C in a single step using the included Git submodule.
97+
The quickest and easiest way to build Paho C++ is to build it together with Paho C in a single step using the included Git submodule.
9498
This requires the CMake option `PAHO_WITH_MQTT_C` set.
9599

96100
```
97101
$ git clone https://github.com/eclipse/paho.mqtt.cpp
98102
$ cd paho.mqtt.cpp
99-
$ git co v1.5.1
103+
$ git co v1.5.2
100104
101105
$ git submodule init
102106
$ git submodule update
@@ -169,7 +173,7 @@ If the Paho C library is not already installed, the recommended version can be b
169173

170174
$ git clone https://github.com/eclipse/paho.mqtt.cpp
171175
$ cd paho.mqtt.cpp
172-
$ git co v1.5.1
176+
$ git co v1.5.2
173177
$ git submodule init
174178
$ git submodule update
175179

@@ -281,12 +285,13 @@ Some things to keep in mind when using the library in a multi-threaded applicati
281285
- For MQTT v5 consider using Subscription Identifiers to map incoming messages to callbacks or queues.
282286
- The various data and options structs (like connect_options) are simple data structs. They are not thread protected.
283287

284-
## Example
288+
## Examples
289+
290+
Sample applications can be found in the source repository at [examples/](https://github.com/eclipse/paho.mqtt.cpp/tree/master/examples).
285291

286-
Sample applications can be found in the source repository at _src/samples_:
287-
https://github.com/eclipse/paho.mqtt.cpp/tree/master/src/samples
292+
These can all be build along with the library by specifying the CMake flag: `-DPAHO_BUILD_EXAMPLES=ON` when configuring the build.
288293

289-
This is a partial example of what a typical example might look like:
294+
This is a partial example of what a typical application might look like:
290295

291296
```cpp
292297
int main(int argc, char* argv[])

examples/rpc_math_srvr.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
// - Connecting to an MQTT server/broker
1010
// - Subscribing to multiple topics
1111
// - Receiving messages through the queueing consumer API
12-
// - Recieving and acting upon commands via MQTT topics
12+
// - Receiving and acting upon commands via MQTT topics
1313
// - Manual reconnects
1414
// - Using a persistent (non-clean) session
1515
//

include/mqtt/async_client.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,7 @@ class async_client : public virtual iasync_client
812812
bool consumer_closed() noexcept override { return !que_ || que_->closed(); }
813813
/**
814814
* Determines if the consumer queue is "done" (closed and empty).
815-
* Once the queue is done, no more events can be added or removed fom
815+
* Once the queue is done, no more events can be added or removed from
816816
* the queue.
817817
* @return @true if the consumer queue is closed and empty, @false
818818
* otherwise.

include/mqtt/iasync_client.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ class iasync_client
465465
virtual bool consumer_closed() noexcept { return false; }
466466
/**
467467
* Determines if the consumer queue is "done" (closed and empty).
468-
* Once the queue is done, no more events can be added or removed fom
468+
* Once the queue is done, no more events can be added or removed from
469469
* the queue.
470470
* @return @true if the consumer queue is closed and empty, @false
471471
* otherwise.

include/mqtt/properties.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ class properties
419419
const property at(size_t i) const {
420420
if (i < size_t(props_.count))
421421
return property{props_.array[i]};
422-
throw std::out_of_range{"propery index"};
422+
throw std::out_of_range{"property index"};
423423
}
424424
/**
425425
* Gets the numbers of property items in the list.

include/mqtt/server_response.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ struct subscribe_response : public server_response
154154
* was sent in the subscribe packet. Each tells the granted QoS
155155
* for the corresponding topic.
156156
*
157-
* For MQTT v5 values over 0x80 are error codes as descibed in the MQTT
157+
* For MQTT v5 values over 0x80 are error codes as described in the MQTT
158158
* v5 spec.
159159
*
160160
* @return A collection of return/reason codes corresponding to

include/mqtt/string_collection.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ using const_string_collection_ptr = string_collection::const_ptr_t;
261261
/////////////////////////////////////////////////////////////////////////////
262262

263263
/**
264-
* A colleciton of name/value string pairs.
264+
* A collection of name/value string pairs.
265265
*/
266266
class name_value_collection
267267
{

include/mqtt/topic.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,13 @@ class topic_filter
212212
*/
213213
explicit topic_filter(const string& filter);
214214
/**
215-
* Determins if the character is a wildcard, '+' or '#'
215+
* Determines if the character is a wildcard, '+' or '#'
216216
* @param c The character to check
217217
* @return @em true if `c` is a wildcard, '+' or '#'
218218
*/
219219
static bool is_wildcard(char c) { return c == '+' || c == '#'; }
220220
/**
221-
* Determins if the string (field) is a wildcard, "+" or "#"
221+
* Determines if the string (field) is a wildcard, "+" or "#"
222222
* @param s The string to check
223223
* @return @em true if `c` is a wildcard, "+" or "#"
224224
*/

0 commit comments

Comments
 (0)