mirror of
https://github.com/boostorg/mqtt5.git
synced 2025-10-04 04:40:55 +02:00
e191679889
Summary: resolves T13126 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Maniphest Tasks: T13126 Differential Revision: https://repo.mireo.local/D26629
129 lines
7.0 KiB
Plaintext
129 lines
7.0 KiB
Plaintext
[library Async.MQTT5: a C++20 MQTT client
|
|
[quickbook 1.7]
|
|
[copyright 2023 Mireo]
|
|
[id async_mqtt5]
|
|
[purpose C++20 MQTT client]
|
|
[license
|
|
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])
|
|
]
|
|
[authors [Siladić, Ivica], [Iljazović, Bruno], [Šimičević, Korina]]
|
|
[category template]
|
|
[category generic]
|
|
]
|
|
|
|
[template nochunk[] [block '''<?dbhtml stop-chunking?>''']]
|
|
[template mdash[] '''— ''']
|
|
[template hr[] '''<phrase role="silver">'''[mdash]'''</phrase>''']
|
|
[template include_file[path][^<'''<ulink url="GITHUB_LINK">'''[path]'''</ulink>'''>]]
|
|
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
|
|
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
|
|
|
|
[template reflink2[id text][link async_mqtt5.ref.[id] [^[text]]]]
|
|
[template reflink[id][reflink2 [id] [id]]]
|
|
[template refmem[class mem][reflink2 [class].[mem] [class]::[mem]]]
|
|
[template refmemunq[class mem][reflink2 [class].[mem] [mem]]]
|
|
[template asioreflink[id term][@boost:/doc/html/boost_asio/reference/[id].html [^boost::asio::[term]]]]
|
|
[template beastreflink[id term][@boost:/libs/beast/doc/html/beast/ref/[id].html [^boost::beast::[term]]]]
|
|
[template beastconceptslink[id term][@boost:/libs/beast/doc/html/beast/concepts/[id].html [term]]]
|
|
[template mqttlink[id text][@https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc[id] [text]]]
|
|
|
|
[def __OPENSSL__ [@https://www.openssl.org/ OpenSSL]]
|
|
|
|
[def __CompletionToken__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.completion_tokens_and_handlers CompletionToken]]
|
|
[def __ExecutionContext__ [reflink ExecutionContext]]
|
|
[def __StreamType__ [reflink StreamType]]
|
|
[def __TlsContext__ [reflink TlsContext]]
|
|
[def __is_authenticator__ [reflink is_authenticator]]
|
|
|
|
[def __Boost__ [@https://www.boost.org/ Boost]]
|
|
[def __Asio__ [@boost:/libs/asio/index.html Boost.Asio]]
|
|
[def __Beast__ [@boost:/libs/beast/index.html Boost.Beast]]
|
|
[def __ASIO_PER_OP_CANCELLATION__ [@boost:/doc/html/boost_asio/overview/core/cancellation.html Per-Operation Cancellation]]
|
|
[def __POST__ [@boost:doc/html/boost_asio/reference/post.html `boost::asio::post`]]
|
|
[def __CO_SPAWN__ [@boost:/doc/html/boost_asio/reference/co_spawn.html `boost::asio::co_spawn`]]
|
|
[def __USE_AWAITABLE__ [@boost:/doc/html/boost_asio/reference/use_awaitable.html `boost::asio::use_awaitable`]]
|
|
[def __USE_FUTURE__ [@boost:/doc/html/boost_asio/reference/use_future.html `boost::asio::use_future`]]
|
|
[def __SSL__ [@boost:/doc/html/boost_asio/overview/ssl.html `SSL`]]
|
|
[def __TCP_SOCKET__ [asioreflink ip__tcp/socket ip::tcp::socket]]
|
|
[def __SSL_CONTEXT__ [asioreflink ssl__context ssl::context]]
|
|
[def __SSL_STREAM__ [asioreflink ssl__stream ssl::stream<__TCP_SOCKET__>]]
|
|
[def __WEBSOCKET_STREAM__ [beastreflink boost__beast__websocket__stream websocket::stream<NextLayer>]]
|
|
|
|
[/ MQTT ]
|
|
[def __MQTT__ [@https://mqtt.org/ MQTT]]
|
|
[def __Self__ [@https://github.com/mireo/async-mqtt5/ Async.MQTT5]]
|
|
[def __Client__ [reflink2 mqtt_client `mqtt_client`]]
|
|
|
|
[def __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]]
|
|
[def __PACKET_SIZE__ [mqttlink 3901024 `packet size`]]
|
|
[def __MAXIMUM_QOS__ [mqttlink 3901084 `Maximum QoS`]]
|
|
[def __RETAIN_AVAILABLE__ [mqttlink 3901085 `Retain Available`]]
|
|
[def __TOPIC_ALIAS_MAX__ [mqttlink 3901051 `Topic Alias Maximum`]]
|
|
[def __QOS__ [mqttlink 3901234 `QoS`]]
|
|
[def __RETAIN__ [mqttlink 3901104 `RETAIN`]]
|
|
[def __SUBSCRIBE_OPTIONS__ [mqttlink 3901169 `Subscribe Options`]]
|
|
[def __ENHANCED_AUTH__ [mqttlink 3901256 `Enhanced Authentication`]]
|
|
|
|
[def __CONNECT__ [mqttlink 3901033 `CONNECT`]]
|
|
[def __CONNACK__ [mqttlink 3901074 `CONNACK`]]
|
|
[def __PUBLISH__ [mqttlink 3901100 `PUBLISH`]]
|
|
[def __PUBACK__ [mqttlink 3901121 `PUBACK`]]
|
|
[def __PUBREC__ [mqttlink 3901131 `PUBREC`]]
|
|
[def __PUBREL__ [mqttlink 3901141 `PUBREL`]]
|
|
[def __PUBCOMP__ [mqttlink 3901151 `PUBCOMP`]]
|
|
[def __SUBSCRIBE__ [mqttlink 3901161 `SUBSCRIBE`]]
|
|
[def __SUBACK__ [mqttlink 3901171 `SUBACK`]]
|
|
[def __UNSUBSCRIBE__ [mqttlink 3901179 `UNSUBSCRIBE`]]
|
|
[def __UNSUBACK__ [mqttlink 3901187 `UNSUBACK`]]
|
|
[def __PINGREQ__ [mqttlink 3901195 `PINGREQ`]]
|
|
[def __PINGRESP__ [mqttlink 3901200 `PINGRESP`]]
|
|
[def __DISCONNECT__ [mqttlink 3901205 `DISCONNECT`]]
|
|
[def __AUTH__ [mqttlink 3901217 `AUTH`]]
|
|
|
|
[def __WILL_PROPS__ [reflink2 will_props async_mqtt5::will_props]]
|
|
[def __CONNECT_PROPS__ [reflink2 connect_props async_mqtt5::connect_props]]
|
|
[def __CONNACK_PROPS__ [reflink2 connack_props async_mqtt5::connack_props]]
|
|
[def __PUBLISH_PROPS__ [reflink2 publish_props async_mqtt5::publish_props]]
|
|
[def __PUBACK_PROPS__ [reflink2 puback_props async_mqtt5::puback_props]]
|
|
[def __PUBREC_PROPS__ [reflink2 pubrec_props async_mqtt5::pubrec_props]]
|
|
[def __PUBREL_PROPS__ [reflink2 pubrel_props async_mqtt5::pubrel_props]]
|
|
[def __PUBCOMP_PROPS__ [reflink2 pubcomp_props async_mqtt5::pubcomp_props]]
|
|
[def __SUBSCRIBE_PROPS__ [reflink2 subscribe_props async_mqtt5::subscribe_props]]
|
|
[def __SUBACK_PROPS__ [reflink2 suback_props async_mqtt5::suback_props]]
|
|
[def __UNSUBSCRIBE_PROPS__ [reflink2 unsubscribe_props async_mqtt5::unsubscribe_props]]
|
|
[def __UNSUBACK_PROPS__ [reflink2 unsuback_props async_mqtt5::unsuback_props]]
|
|
[def __DISCONNECT_PROPS__ [reflink2 disconnect_props async_mqtt5::disconnect_props]]
|
|
[def __AUTH_PROPS__ [reflink2 auth_props async_mqtt5::auth_props]]
|
|
|
|
[def __ERROR_CODE__ [reflink2 error_code `async_mqtt5::error_code`]]
|
|
[def __REASON_CODE__ [reflink2 reason_code `async_mqtt5::reason_code`]]
|
|
|
|
[def __REASON_CODES__ [reflink2 Reason_codes `Reason Codes`]]
|
|
[def __ERROR_HANDLING__ [reflink2 Error_handling `Error handling`]]
|
|
|
|
[def __EXAMPLE_CALLBACK__ [link async_mqtt5.examples.callbacks Async functions with callbacks]]
|
|
[def __EXAMPLE_COROUTINE__ [link async_mqtt5.examples.cpp20_coroutines Async functions with C++20 coroutines]]
|
|
[def __EXAMPLE_FUTURE__ [link async_mqtt5.examples.futures Async functions with futures]]
|
|
|
|
[include 01_intro.qbk]
|
|
[include 02_examples.qbk]
|
|
|
|
[include reference/reference.qbk]
|
|
|
|
[h3 Table of Contents]
|
|
* [link async_mqtt5.intro Introduction]
|
|
* [link async_mqtt5.examples Examples]
|
|
* [link async_mqtt5.examples.publisher The publisher]
|
|
* [link async_mqtt5.examples.receiver The receiver]
|
|
* [link async_mqtt5.examples.network_connection Establishing a network connection with different protocols]
|
|
* [link async_mqtt5.examples.network_connection.tcp_ip_connection TCP/IP connection]
|
|
* [link async_mqtt5.examples.network_connection.tls_ssl_connection TLS/SSL connection]
|
|
* [link async_mqtt5.examples.network_connection.websocket_connection WebSocket connection]
|
|
* [link async_mqtt5.examples.completion_tokens Completion tokens]
|
|
* [link async_mqtt5.examples.callbacks Async functions with callbacks]
|
|
* [link async_mqtt5.examples.cpp20_coroutines Async functions with C++20 coroutines]
|
|
* [link async_mqtt5.examples.futures Async functions with futures]
|
|
* [link async_mqtt5.ref Reference]
|