forked from boostorg/mqtt5
Korina Šimičević
319d024981
Summary: related to T15252, T15261, T15263, #24 - documented LoggerType concept - configuring the client chapter changed to getting started chapter with new additions: - code examples for each section (choosing underlying type, configuring the client, and using it) - added a secion on debugging the client using our logger implementation - minor fixes related to reviewer's suggestions Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D32487
86 lines
5.1 KiB
XML
86 lines
5.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
|
|
|
<!--
|
|
Copyright (c) 2023-2024 Ivica Siladic, Bruno Iljazovic, Korina Simicevic
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
-->
|
|
|
|
<informaltable frame="all">
|
|
<tgroup cols="4">
|
|
<colspec colname="a"/><colspec colname="b"/><colspec colname="c"/><colspec colname="d"/>
|
|
<tbody><row>
|
|
<entry valign="top">
|
|
<bridgehead renderas="sect3">Classes</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.authority_path">authority_path</link></member>
|
|
<member><link linkend="async_mqtt5.ref.mqtt_client">mqtt_client</link></member>
|
|
<member><link linkend="async_mqtt5.ref.reason_code">reason_code</link></member>
|
|
<member><link linkend="async_mqtt5.ref.subscribe_options">subscribe_options</link></member>
|
|
<member><link linkend="async_mqtt5.ref.subscribe_topic">subscribe_topic</link></member>
|
|
<member><link linkend="async_mqtt5.ref.will">will</link></member>
|
|
</simplelist>
|
|
<bridgehead renderas="sect3">Concepts</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.ExecutionContext">ExecutionContext</link></member>
|
|
<member><link linkend="async_mqtt5.ref.StreamType">StreamType</link></member>
|
|
<member><link linkend="async_mqtt5.ref.TlsContext">TlsContext</link></member>
|
|
<member><link linkend="async_mqtt5.ref.is_authenticator">is_authenticator</link></member>
|
|
</simplelist>
|
|
</entry>
|
|
<entry valign="top">
|
|
<bridgehead renderas="sect3">Type aliases</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.error_code">error_code</link></member>
|
|
</simplelist>
|
|
<bridgehead renderas="sect3">Enumerations</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.auth_step_e">auth_step_e</link></member>
|
|
<member><link linkend="async_mqtt5.ref.client.error">client::error</link></member>
|
|
<member><link linkend="async_mqtt5.ref.disconnect_rc_e">disconnect_rc_e</link></member>
|
|
<member><link linkend="async_mqtt5.ref.qos_e">qos_e</link></member>
|
|
<member><link linkend="async_mqtt5.ref.retain_e">retain_e</link></member>
|
|
</simplelist>
|
|
<bridgehead renderas="sect3">Functions</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.client.get_error_code_category">get_error_code_category</link></member>
|
|
<member><link linkend="async_mqtt5.ref.client.make_error_code">make_error_code</link></member>
|
|
</simplelist>
|
|
</entry>
|
|
<entry valign="top">
|
|
<bridgehead renderas="sect3">Properties</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.will_props">will_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.connect_props">connect_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.connack_props">connack_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.publish_props">publish_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.puback_props">puback_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.pubrec_props">pubrec_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.pubrel_props">pubrel_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.pubcomp_props">pubcomp_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.subscribe_props">subscribe_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.suback_props">suback_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.unsubscribe_props">unsubscribe_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.unsuback_props">unsuback_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.disconnect_props">disconnect_props</link></member>
|
|
<member><link linkend="async_mqtt5.ref.auth_props">auth_props</link></member>
|
|
</simplelist>
|
|
</entry>
|
|
<entry valign="top">
|
|
<bridgehead renderas="sect3">Reference tables</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.Reason_codes">Reason codes</link></member>
|
|
<member><link linkend="async_mqtt5.ref.Error_handling">Error handling</link></member>
|
|
</simplelist>
|
|
<bridgehead renderas="sect3">Logging</bridgehead>
|
|
<simplelist type="vert" columns="1">
|
|
<member><link linkend="async_mqtt5.ref.LoggerType">LoggerType</link></member>
|
|
<member><link linkend="async_mqtt5.ref.logger">logger</link></member>
|
|
<member><link linkend="async_mqtt5.ref.log_level">log_level</link></member>
|
|
</simplelist>
|
|
</entry>
|
|
</row></tbody>
|
|
</tgroup>
|
|
</informaltable>
|