boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-10-09 23:00:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
47ef696779cab6dc1ecb8d2d50875c19574c06c3
mqtt5/doc/qbk/02_examples.qbk

36 lines
1.4 KiB
Plaintext
Raw Normal View History

[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[/
Copyright (c) 2023 Mireo
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
]
[mqtt-client] added chapter on different ways to establish network connection Summary: related to T12804 - added chapter on network connection - added code examples - remove any_authenticator from doc targets - manually create table of contents Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26401
2023-11-03 13:40:03 +01:00
[section:examples Examples]
[mqtt-client] introduction v1 Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26513
2023-11-15 09:20:59 +01:00
The main class in __Self__ is __Client__, and the upcoming sections will briefly explain how to use it.
[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[mqtt-client] introduction v1 Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26513
2023-11-15 09:20:59 +01:00
The first two examples will demonstrate using __Client__ as a publisher and receiver.
* [link async_mqtt5.examples.publisher The publisher]
* [link async_mqtt5.examples.receiver The receiver]
The following two sections serve as reference.
[mqtt-client] added chapter on different ways to establish network connection Summary: related to T12804 - added chapter on network connection - added code examples - remove any_authenticator from doc targets - manually create table of contents Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26401
2023-11-03 13:40:03 +01:00
The first section will show how to use different underlying transport protocols (such as TCP, SSL and WebSocket)
[mqtt-client] introduction v1 Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26513
2023-11-15 09:20:59 +01:00
to establish a connection to an MQTT Broker.
[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[mqtt-client] added chapter on different ways to establish network connection Summary: related to T12804 - added chapter on network connection - added code examples - remove any_authenticator from doc targets - manually create table of contents Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26401
2023-11-03 13:40:03 +01:00
* [link async_mqtt5.examples.network_connection Establishing a network connection with different protocols]
[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[mqtt-client] introduction v1 Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26513
2023-11-15 09:20:59 +01:00
The second section will showcase how to use asynchronous functions in __Client__
with different completion tokens.
[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[mqtt-client] added chapter on different ways to establish network connection Summary: related to T12804 - added chapter on network connection - added code examples - remove any_authenticator from doc targets - manually create table of contents Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26401
2023-11-03 13:40:03 +01:00
* [link async_mqtt5.examples.asio Compatibility with Boost.Asio]
* [link async_mqtt5.examples.asio.callbacks Async functions with callbacks]
* [link async_mqtt5.examples.asio.cpp20_coroutines Async functions with C++20 coroutines]
* [link async_mqtt5.examples.asio.futures Async functions with futures]
[mqtt-client] introduction v1 Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26513
2023-11-15 09:20:59 +01:00
[include examples/Basic_examples.qbk]
[mqtt-client] added chapter on different ways to establish network connection Summary: related to T12804 - added chapter on network connection - added code examples - remove any_authenticator from doc targets - manually create table of contents Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26401
2023-11-03 13:40:03 +01:00
[include examples/Network_connection.qbk]
[include examples/Asio_compatibility.qbk]
[mqtt-client] mqtt_client with asio::use_future documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26370
2023-11-02 12:50:08 +01:00
[mqtt-client] coroutine & callback examples Summary: related to T12804 - added asio::no_recovery to list of possible error codes - added examples with asio::use_awaitable and callbacks as completion tokens Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26355
2023-10-31 15:10:34 +01:00
[endsect]
Reference in New Issue Copy Permalink