2023-10-13 09:07:56 +02:00
|
|
|
[library async_mqtt5
|
|
|
|
[quickbook 1.7]
|
|
|
|
[copyright 2023 Mireo]
|
|
|
|
[id async_mqtt5]
|
|
|
|
[purpose MQTT C++ client library]
|
|
|
|
[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 [A,B,C]]
|
|
|
|
[category template]
|
|
|
|
[category generic]
|
|
|
|
]
|
|
|
|
|
|
|
|
[template nochunk[] [block '''<?dbhtml stop-chunking?>''']]
|
|
|
|
[template mdash[] '''— ''']
|
|
|
|
[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.async_mqtt5__[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]]]
|
2023-10-16 15:57:26 +02:00
|
|
|
[template mqttlink[id text][@https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc[id] [text]]]
|
2023-10-13 09:07:56 +02:00
|
|
|
|
2023-10-16 15:57:26 +02:00
|
|
|
[def __CompletionToken__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.completion_tokens_and_handlers ['CompletionToken]]]
|
2023-10-13 09:07:56 +02:00
|
|
|
[def __ExecutionContext__ [reflink2 ExecutionContext ['ExecutionContext]]]
|
|
|
|
[def __StreamType__ [reflink2 StreamType ['StreamType]]]
|
|
|
|
[def __TlsContext__ [reflink2 TlsContext ['TlsContext]]]
|
|
|
|
|
|
|
|
[def __Boost__ [@https://www.boost.org/ Boost]]
|
|
|
|
[def __Asio__ [@boost:/libs/asio/index.html Boost.Asio]]
|
|
|
|
[def __Self__ [async_mqtt5]]
|
|
|
|
|
|
|
|
[/ MQTT stuff]
|
|
|
|
[def __MQTT__ [@https://mqtt.org/ MQTT]]
|
2023-10-16 15:57:26 +02:00
|
|
|
[def __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]]
|
|
|
|
[def __PACKET_SIZE__ [mqttlink 3901024 `packet size`]]
|
|
|
|
[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`]]
|
2023-10-13 09:07:56 +02:00
|
|
|
|
|
|
|
[include 01_intro.qbk]
|
|
|
|
|
|
|
|
[section:ref Reference]
|
2023-10-16 15:57:26 +02:00
|
|
|
[xinclude reference/quickref.xml]
|
|
|
|
|
2023-10-13 09:07:56 +02:00
|
|
|
[block'''<part label="Two: Reference">''']
|
|
|
|
[include reference.qbk]
|
2023-10-16 15:57:26 +02:00
|
|
|
[include reference/ExecutionContext.qbk]
|
|
|
|
[include reference/StreamType.qbk]
|
|
|
|
[include reference/TlsContext.qbk]
|
|
|
|
[include reference/reason_codes/Reason_codes.qbk]
|
|
|
|
[include reference/properties/Properties.qbk]
|
2023-10-13 09:07:56 +02:00
|
|
|
[block'''</part>''']
|
|
|
|
[endsect]
|
|
|
|
|