boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-11-04 01:41:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation and examples for clarity

Browse Source 
Summary:
related to T13767

- Rewrite chaining of configuration functions
- Move examples not related to documentation to dev folder
- Rewrite links for clarity
- Update CMakeLists.txt to run one of the examples
- Rewrite auto reconnect and auto retry mechanism for clarity

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen, iljazovic

Differential Revision: https://repo.mireo.local/D29044
This commit is contained in:
Korina Šimičević
2024-04-24 14:03:18 +02:00
parent bfae05f7a9
commit 9b7f852342
14 changed files with 31 additions and 1254 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
example/hello_world_over_websocket_tls.cpp
View File

@@ -12,12 +12,12 @@
namespace boost::beast::websocket {
// ``[beastreflink boost__beast__websocket__async_teardown boost::beast::websocket::async_teardown]`` is a free function
// designed to initiate the asynchronous teardown of a connection.
// boost::beast::websocket::async_teardown is a free function designed to initiate the asynchronous teardown of a connection.
// The specific behaviour of this function is based on the NextLayer type (Socket type) used to create the ``__WEBSOCKET_STREAM__``.
// ``__Beast__`` library includes an implementation of this function for ``__TCP_SOCKET__``.
// However, the callers are responsible for providing a suitable overload of this function for any other type,
// such as ``__SSL_STREAM__`` as shown in this example.
// See ``__BEAST_ASYNC_TEARDOWN__`` for more information.
template <typename TeardownHandler>
void async_teardown(
boost::beast::role_type role,
@@ -82,8 +82,8 @@ int main() {
std::cout << "Failed to set peer verification mode!" << std::endl;
ec.clear();
// Construct the Client with ``[beastreflink boost__beast__websocket__stream websocket::stream<__SSL_STREAM__>]``
// as the underlying stream with ``__SSL_CONTEXT__`` as the ``__TlsContext__`` type.
// Construct the Client with WebSocket/SSL as the underlying stream
// with ``__SSL_CONTEXT__`` as the ``__TlsContext__`` type.
async_mqtt5::mqtt_client<
boost::beast::websocket::stream<boost::asio::ssl::stream<boost::asio::ip::tcp::socket>>,
boost::asio::ssl::context
@@ -104,4 +104,4 @@ int main() {
ioc.run();
}
//]
//]