boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-11-07 03:11:38 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
9cb54f73a41e368c33a0a4a8625102bcbbddfb93
mqtt5/doc/qbk/reference/quickref.xml

75 lines
4.6 KiB
XML
Raw Normal View History

[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
<?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">
<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">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<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>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
</simplelist>
<bridgehead renderas="sect3">Concepts</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<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>
[mqtt-client] add support for enhanced authentication Summary: - Relates to T12899 - TODO: support re-authentication Reviewers: ivica Reviewed By: ivica Subscribers: korina Maniphest Tasks: T12899 Differential Revision: https://repo.mireo.local/D26327
2023-11-03 08:38:28 +01:00
<member><link linkend="async_mqtt5.ref.is_authenticator">is_authenticator</link></member>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
</simplelist>
</entry>
<entry valign="top">
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
<bridgehead renderas="sect3">Type aliases</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<member><link linkend="async_mqtt5.ref.error_code">error_code</link></member>
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
</simplelist>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
<bridgehead renderas="sect3">Enumerations</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] add support for enhanced authentication Summary: - Relates to T12899 - TODO: support re-authentication Reviewers: ivica Reviewed By: ivica Subscribers: korina Maniphest Tasks: T12899 Differential Revision: https://repo.mireo.local/D26327
2023-11-03 08:38:28 +01:00
<member><link linkend="async_mqtt5.ref.auth_step_e">auth_step_e</link></member>
Add connection error codes Summary: related to T13651 - separate code related to reason codes into their own header - introduce new connection error codes that will be return when a non-recoverable error occurs in connect_op - add appropriate coverage tests Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D27808
2024-02-05 15:25:05 +01:00
<member><link linkend="async_mqtt5.ref.connection.error">connection::error</link></member>
<member><link linkend="async_mqtt5.ref.client.error">client::error</link></member>
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<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>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
</simplelist>
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<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>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
</simplelist>
</entry>
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
<entry valign="top">
<bridgehead renderas="sect3">Properties</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<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>
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
</simplelist>
</entry>
[mqtt-client] slightly better error code documentation Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26165
2023-10-19 15:05:22 +02:00
<entry valign="top">
<bridgehead renderas="sect3">Reference tables</bridgehead>
<simplelist type="vert" columns="1">
[mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219
2023-10-23 15:45:56 +02:00
<member><link linkend="async_mqtt5.ref.Reason_codes">Reason codes</link></member>
<member><link linkend="async_mqtt5.ref.Error_handling">Error handling</link></member>
[mqtt-client] slightly better error code documentation Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26165
2023-10-19 15:05:22 +02:00
</simplelist>
</entry>
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
</row></tbody>
</tgroup>
</informaltable>
Reference in New Issue Copy Permalink