From 102f878320f9108cff1d496702194aaa45e46470 Mon Sep 17 00:00:00 2001 From: Takatoshi Kondo Date: Tue, 25 Jun 2024 00:55:16 +0900 Subject: [PATCH] Updated documents. --- CHANGELOG.adoc | 9 +- CMakeLists.txt | 4 +- README.md | 2 +- doc/CHANGELOG.html | 31 +- doc/api/all_8hpp_source.html | 2 +- doc/api/annotated.html | 2 +- doc/api/buffer_8hpp_source.html | 2 +- ...ffer__to__packet__variant_8hpp_source.html | 2 +- ...sync__mqtt_1_1basic__endpoint-members.html | 2 +- .../classasync__mqtt_1_1basic__endpoint.html | 2 +- ...qtt_1_1basic__packet__variant-members.html | 2 +- ...async__mqtt_1_1basic__packet__variant.html | 2 +- ...basic__store__packet__variant-members.html | 2 +- ...mqtt_1_1basic__store__packet__variant.html | 2 +- .../classasync__mqtt_1_1buffer-members.html | 2 +- doc/api/classasync__mqtt_1_1buffer.html | 2 +- .../classasync__mqtt_1_1client-members.html | 45 +- doc/api/classasync__mqtt_1_1client.html | 165 ++--- doc/api/classasync__mqtt_1_1client.js | 2 - ...1assigned__client__identifier-members.html | 2 +- ...perty_1_1assigned__client__identifier.html | 2 +- ...perty_1_1authentication__data-members.html | 2 +- ...t_1_1property_1_1authentication__data.html | 2 +- ...rty_1_1authentication__method-members.html | 2 +- ...1_1property_1_1authentication__method.html | 2 +- ..._1_1property_1_1content__type-members.html | 2 +- ...nc__mqtt_1_1property_1_1content__type.html | 2 +- ...property_1_1correlation__data-members.html | 2 +- ...mqtt_1_1property_1_1correlation__data.html | 2 +- ...erty_1_1maximum__packet__size-members.html | 2 +- ..._1_1property_1_1maximum__packet__size.html | 2 +- ...t_1_1property_1_1maximum__qos-members.html | 2 +- ...ync__mqtt_1_1property_1_1maximum__qos.html | 2 +- ..._1_1message__expiry__interval-members.html | 2 +- ...property_1_1message__expiry__interval.html | 2 +- ...1_1payload__format__indicator-members.html | 2 +- ...roperty_1_1payload__format__indicator.html | 2 +- ...1_1property_1_1reason__string-members.html | 2 +- ...c__mqtt_1_1property_1_1reason__string.html | 2 +- ...1property_1_1receive__maximum-members.html | 2 +- ..._mqtt_1_1property_1_1receive__maximum.html | 2 +- ...request__problem__information-members.html | 2 +- ...erty_1_1request__problem__information.html | 2 +- ...equest__response__information-members.html | 2 +- ...rty_1_1request__response__information.html | 2 +- ...erty_1_1response__information-members.html | 2 +- ..._1_1property_1_1response__information.html | 2 +- ..._1property_1_1response__topic-members.html | 2 +- ...__mqtt_1_1property_1_1response__topic.html | 2 +- ...property_1_1retain__available-members.html | 2 +- ...mqtt_1_1property_1_1retain__available.html | 2 +- ...operty_1_1server__keep__alive-members.html | 2 +- ...tt_1_1property_1_1server__keep__alive.html | 2 +- ...property_1_1server__reference-members.html | 2 +- ...mqtt_1_1property_1_1server__reference.html | 2 +- ..._1_1session__expiry__interval-members.html | 2 +- ...property_1_1session__expiry__interval.html | 2 +- ...ared__subscription__available-members.html | 2 +- ...ty_1_1shared__subscription__available.html | 2 +- ...y_1_1subscription__identifier-members.html | 2 +- ...1property_1_1subscription__identifier.html | 2 +- ...iption__identifier__available-members.html | 2 +- ..._1subscription__identifier__available.html | 2 +- ...t_1_1property_1_1topic__alias-members.html | 2 +- ...ync__mqtt_1_1property_1_1topic__alias.html | 2 +- ...erty_1_1topic__alias__maximum-members.html | 2 +- ..._1_1property_1_1topic__alias__maximum.html | 2 +- ...1_1property_1_1user__property-members.html | 2 +- ...c__mqtt_1_1property_1_1user__property.html | 2 +- ...card__subscription__available-members.html | 2 +- ..._1_1wildcard__subscription__available.html | 2 +- ...erty_1_1will__delay__interval-members.html | 2 +- ..._1_1property_1_1will__delay__interval.html | 2 +- ...nc__mqtt_1_1property__variant-members.html | 2 +- ...classasync__mqtt_1_1property__variant.html | 2 +- ...ync__mqtt_1_1topic__sharename-members.html | 2 +- .../classasync__mqtt_1_1topic__sharename.html | 2 +- ...async__mqtt_1_1topic__subopts-members.html | 2 +- .../classasync__mqtt_1_1topic__subopts.html | 2 +- ...1__1_1_1basic__puback__packet-members.html | 2 +- ..._1_1v3__1__1_1_1basic__puback__packet.html | 2 +- ...__1_1_1basic__pubcomp__packet-members.html | 2 +- ...1_1v3__1__1_1_1basic__pubcomp__packet.html | 2 +- ...__1_1_1basic__publish__packet-members.html | 2 +- ...1_1v3__1__1_1_1basic__publish__packet.html | 2 +- ...1__1_1_1basic__pubrec__packet-members.html | 2 +- ..._1_1v3__1__1_1_1basic__pubrec__packet.html | 2 +- ...1__1_1_1basic__pubrel__packet-members.html | 2 +- ..._1_1v3__1__1_1_1basic__pubrel__packet.html | 2 +- ...1__1_1_1basic__suback__packet-members.html | 2 +- ..._1_1v3__1__1_1_1basic__suback__packet.html | 2 +- ...1_1_1basic__subscribe__packet-members.html | 2 +- ...1v3__1__1_1_1basic__subscribe__packet.html | 2 +- ..._1_1_1basic__unsuback__packet-members.html | 2 +- ..._1v3__1__1_1_1basic__unsuback__packet.html | 2 +- ...1_1basic__unsubscribe__packet-members.html | 2 +- ...3__1__1_1_1basic__unsubscribe__packet.html | 2 +- ..._1v3__1__1_1_1connack__packet-members.html | 2 +- ...__mqtt_1_1v3__1__1_1_1connack__packet.html | 2 +- ..._1v3__1__1_1_1connect__packet-members.html | 2 +- ...__mqtt_1_1v3__1__1_1_1connect__packet.html | 2 +- ...3__1__1_1_1disconnect__packet-members.html | 2 +- ...qtt_1_1v3__1__1_1_1disconnect__packet.html | 2 +- ..._1v3__1__1_1_1pingreq__packet-members.html | 2 +- ...__mqtt_1_1v3__1__1_1_1pingreq__packet.html | 2 +- ...1v3__1__1_1_1pingresp__packet-members.html | 2 +- ..._mqtt_1_1v3__1__1_1_1pingresp__packet.html | 2 +- ...c__mqtt_1_1v5_1_1auth__packet-members.html | 2 +- ...lassasync__mqtt_1_1v5_1_1auth__packet.html | 2 +- ..._1v5_1_1basic__puback__packet-members.html | 2 +- ...__mqtt_1_1v5_1_1basic__puback__packet.html | 2 +- ...1v5_1_1basic__pubcomp__packet-members.html | 2 +- ..._mqtt_1_1v5_1_1basic__pubcomp__packet.html | 2 +- ...1v5_1_1basic__publish__packet-members.html | 2 +- ..._mqtt_1_1v5_1_1basic__publish__packet.html | 2 +- ..._1v5_1_1basic__pubrec__packet-members.html | 2 +- ...__mqtt_1_1v5_1_1basic__pubrec__packet.html | 2 +- ..._1v5_1_1basic__pubrel__packet-members.html | 2 +- ...__mqtt_1_1v5_1_1basic__pubrel__packet.html | 2 +- ..._1v5_1_1basic__suback__packet-members.html | 2 +- ...__mqtt_1_1v5_1_1basic__suback__packet.html | 2 +- ...5_1_1basic__subscribe__packet-members.html | 2 +- ...qtt_1_1v5_1_1basic__subscribe__packet.html | 2 +- ...v5_1_1basic__unsuback__packet-members.html | 2 +- ...mqtt_1_1v5_1_1basic__unsuback__packet.html | 2 +- ...1_1basic__unsubscribe__packet-members.html | 2 +- ...t_1_1v5_1_1basic__unsubscribe__packet.html | 2 +- ...mqtt_1_1v5_1_1connack__packet-members.html | 2 +- ...sasync__mqtt_1_1v5_1_1connack__packet.html | 2 +- ...mqtt_1_1v5_1_1connect__packet-members.html | 2 +- ...sasync__mqtt_1_1v5_1_1connect__packet.html | 2 +- ...t_1_1v5_1_1disconnect__packet-members.html | 2 +- ...ync__mqtt_1_1v5_1_1disconnect__packet.html | 2 +- ...mqtt_1_1v5_1_1pingreq__packet-members.html | 2 +- ...sasync__mqtt_1_1v5_1_1pingreq__packet.html | 2 +- ...qtt_1_1v5_1_1pingresp__packet-members.html | 2 +- ...async__mqtt_1_1v5_1_1pingresp__packet.html | 2 +- doc/api/classasync__mqtt_1_1will-members.html | 2 +- doc/api/classasync__mqtt_1_1will.html | 2 +- doc/api/classes.html | 2 +- ..._01async__mqtt_1_1buffer_01_4-members.html | 2 +- ..._1hash_3_01async__mqtt_1_1buffer_01_4.html | 2 +- doc/api/client_8hpp_source.html | 700 +++++++++--------- .../control__packet__type_8hpp_source.html | 2 +- ...customized__basic__stream_8hpp_source.html | 2 +- doc/api/customized__ssl__stream_8hpp.html | 2 +- .../customized__ssl__stream_8hpp_source.html | 2 +- .../customized__websocket__stream_8hpp.html | 2 +- ...omized__websocket__stream_8hpp_source.html | 2 +- .../dir_cce41e6148f04805f4e76e6a36ba88d6.html | 2 +- .../dir_ce1a31e6a52137e313c4ed05ef460346.html | 2 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- .../dir_df0bffcb61356486763cc61cf65485e2.html | 2 +- .../dir_f8efeb8e1feb6bbd3b8b0bf040091d61.html | 2 +- doc/api/doxygen_crawl.html | 3 +- doc/api/endian__convert_8hpp_source.html | 2 +- doc/api/endpoint_8hpp_source.html | 4 +- doc/api/endpoint__fwd_8hpp_source.html | 2 +- doc/api/error_8hpp_source.html | 2 +- doc/api/files.html | 2 +- doc/api/functions.html | 2 +- doc/api/functions_b.html | 2 +- doc/api/functions_c.html | 6 +- doc/api/functions_d.html | 2 +- doc/api/functions_e.html | 2 +- doc/api/functions_f.html | 2 +- doc/api/functions_func.html | 2 +- doc/api/functions_func_b.html | 2 +- doc/api/functions_func_c.html | 6 +- doc/api/functions_func_d.html | 2 +- doc/api/functions_func_e.html | 2 +- doc/api/functions_func_f.html | 2 +- doc/api/functions_func_g.html | 2 +- doc/api/functions_func_h.html | 2 +- doc/api/functions_func_i.html | 2 +- doc/api/functions_func_k.html | 2 +- doc/api/functions_func_l.html | 2 +- doc/api/functions_func_m.html | 2 +- doc/api/functions_func_n.html | 2 +- doc/api/functions_func_o.html | 2 +- doc/api/functions_func_p.html | 2 +- doc/api/functions_func_r.html | 2 +- doc/api/functions_func_s.html | 2 +- doc/api/functions_func_t.html | 2 +- doc/api/functions_func_u.html | 2 +- doc/api/functions_func_v.html | 2 +- doc/api/functions_func_w.html | 2 +- doc/api/functions_func_~.html | 2 +- doc/api/functions_g.html | 2 +- doc/api/functions_h.html | 2 +- doc/api/functions_i.html | 2 +- doc/api/functions_k.html | 2 +- doc/api/functions_l.html | 2 +- doc/api/functions_m.html | 2 +- doc/api/functions_n.html | 2 +- doc/api/functions_o.html | 2 +- doc/api/functions_p.html | 2 +- doc/api/functions_r.html | 2 +- doc/api/functions_rela.html | 2 +- doc/api/functions_s.html | 2 +- doc/api/functions_t.html | 2 +- doc/api/functions_type.html | 2 +- doc/api/functions_u.html | 2 +- doc/api/functions_v.html | 2 +- doc/api/functions_vars.html | 2 +- doc/api/functions_w.html | 2 +- doc/api/functions_~.html | 2 +- doc/api/graph_legend.html | 2 +- doc/api/group__auth__reason__code.html | 2 +- doc/api/group__auth__v5.html | 2 +- doc/api/group__buffer.html | 2 +- doc/api/group__client.html | 2 +- doc/api/group__client.js | 2 - doc/api/group__connack__v3__1__1.html | 2 +- doc/api/group__connack__v5.html | 2 +- doc/api/group__connect__reason__code.html | 2 +- doc/api/group__connect__return__code.html | 2 +- doc/api/group__connect__v3__1__1.html | 2 +- doc/api/group__connect__v5.html | 2 +- doc/api/group__connection.html | 2 +- doc/api/group__disconnect__reason__code.html | 2 +- doc/api/group__disconnect__v3__1__1.html | 2 +- doc/api/group__disconnect__v5.html | 2 +- doc/api/group__endpoint.html | 2 +- doc/api/group__error.html | 2 +- doc/api/group__error__reporting.html | 2 +- doc/api/group__log.html | 2 +- doc/api/group__mqtt.html | 2 +- doc/api/group__mqtt__error.html | 2 +- doc/api/group__packet.html | 2 +- doc/api/group__packet__detail.html | 2 +- doc/api/group__packet__v3__1__1.html | 2 +- doc/api/group__packet__v5.html | 2 +- doc/api/group__packet__variant.html | 2 +- doc/api/group__packet__variant__detail.html | 2 +- doc/api/group__pingreq__v3__1__1.html | 2 +- doc/api/group__pingreq__v5.html | 2 +- doc/api/group__pingresp__v3__1__1.html | 2 +- doc/api/group__pingresp__v5.html | 2 +- doc/api/group__predefined__customize.html | 2 +- doc/api/group__predefined__layer.html | 2 +- doc/api/group__predefined__layer__mqtt.html | 2 +- doc/api/group__predefined__layer__mqtts.html | 2 +- doc/api/group__predefined__layer__ws.html | 2 +- doc/api/group__predefined__layer__wss.html | 2 +- doc/api/group__property.html | 2 +- doc/api/group__property__internal.html | 2 +- doc/api/group__property__variant.html | 2 +- doc/api/group__puback__reason__code.html | 2 +- doc/api/group__puback__v3__1__1.html | 2 +- doc/api/group__puback__v3__1__1__detail.html | 2 +- doc/api/group__puback__v5.html | 2 +- doc/api/group__puback__v5__detail.html | 2 +- doc/api/group__pubcomp__reason__code.html | 2 +- doc/api/group__pubcomp__v3__1__1.html | 2 +- doc/api/group__pubcomp__v3__1__1__detail.html | 2 +- doc/api/group__pubcomp__v5.html | 2 +- doc/api/group__pubcomp__v5__detail.html | 2 +- doc/api/group__publish__options.html | 2 +- doc/api/group__publish__v3__1__1.html | 2 +- doc/api/group__publish__v3__1__1__detail.html | 2 +- doc/api/group__publish__v5.html | 2 +- doc/api/group__publish__v5__detail.html | 2 +- doc/api/group__pubrec__reason__code.html | 2 +- doc/api/group__pubrec__v3__1__1.html | 2 +- doc/api/group__pubrec__v3__1__1__detail.html | 2 +- doc/api/group__pubrec__v5.html | 2 +- doc/api/group__pubrec__v5__detail.html | 2 +- doc/api/group__pubrel__reason__code.html | 2 +- doc/api/group__pubrel__v3__1__1.html | 2 +- doc/api/group__pubrel__v3__1__1__detail.html | 2 +- doc/api/group__pubrel__v5.html | 2 +- doc/api/group__pubrel__v5__detail.html | 2 +- doc/api/group__qos.html | 2 +- doc/api/group__role.html | 2 +- doc/api/group__store__packet__variant.html | 2 +- ...group__store__packet__variant__detail.html | 2 +- doc/api/group__suback__reason__code.html | 2 +- doc/api/group__suback__return__code.html | 2 +- doc/api/group__suback__v3__1__1.html | 2 +- doc/api/group__suback__v3__1__1__detail.html | 2 +- doc/api/group__suback__v5.html | 2 +- doc/api/group__suback__v5__detail.html | 2 +- doc/api/group__subscribe__options.html | 2 +- doc/api/group__subscribe__v3__1__1.html | 2 +- .../group__subscribe__v3__1__1__detail.html | 2 +- doc/api/group__subscribe__v5.html | 2 +- doc/api/group__subscribe__v5__detail.html | 2 +- doc/api/group__underlying__customize.html | 2 +- doc/api/group__underlying__layer.html | 2 +- doc/api/group__unsuback__reason__code.html | 2 +- doc/api/group__unsuback__v3__1__1.html | 2 +- .../group__unsuback__v3__1__1__detail.html | 2 +- doc/api/group__unsuback__v5.html | 2 +- doc/api/group__unsuback__v5__detail.html | 2 +- doc/api/group__unsubscribe__v3__1__1.html | 2 +- .../group__unsubscribe__v3__1__1__detail.html | 2 +- doc/api/group__unsubscribe__v5.html | 2 +- doc/api/group__unsubscribe__v5__detail.html | 2 +- doc/api/host__port_8hpp_source.html | 2 +- doc/api/index.html | 2 +- doc/api/inline_8hpp_source.html | 2 +- doc/api/ioc__queue_8hpp_source.html | 2 +- doc/api/json__like__out_8hpp_source.html | 2 +- doc/api/log_8hpp_source.html | 2 +- doc/api/make__shared__helper_8hpp_source.html | 2 +- doc/api/move_8hpp_source.html | 2 +- doc/api/mqtt_8hpp_source.html | 2 +- doc/api/mqtts_8hpp_source.html | 2 +- doc/api/navtreedata.js | 10 +- doc/api/navtreeindex0.js | 68 +- doc/api/navtreeindex1.js | 6 +- doc/api/navtreeindex2.js | 6 +- doc/api/navtreeindex3.js | 6 +- doc/api/navtreeindex4.js | 6 +- doc/api/navtreeindex5.js | 6 +- doc/api/navtreeindex6.js | 2 - doc/api/overload_8hpp_source.html | 2 +- doc/api/packet__fwd_8hpp_source.html | 2 +- doc/api/packet__helper_8hpp_source.html | 2 +- doc/api/packet__id__manager_8hpp_source.html | 2 +- doc/api/packet__id__type_8hpp_source.html | 2 +- doc/api/packet__iterator_8hpp_source.html | 2 +- doc/api/packet__traits_8hpp_source.html | 2 +- doc/api/packet__variant_8hpp_source.html | 2 +- doc/api/packet__variant__fwd_8hpp_source.html | 2 +- doc/api/property_8hpp_source.html | 2 +- doc/api/property__id_8hpp_source.html | 2 +- doc/api/property__variant_8hpp_source.html | 2 +- doc/api/protocol__version_8hpp_source.html | 2 +- doc/api/pubopts_8hpp_source.html | 2 +- doc/api/qos_8hpp_source.html | 2 +- doc/api/qos__util_8hpp_source.html | 2 +- doc/api/role_8hpp_source.html | 4 +- doc/api/scope__guard_8hpp_source.html | 2 +- doc/api/search/all_6.js | 4 +- doc/api/search/functions_2.js | 4 +- doc/api/setup__log_8hpp_source.html | 2 +- doc/api/shared__ptr__array_8hpp_source.html | 2 +- doc/api/src_8hpp_source.html | 2 +- doc/api/static__vector_8hpp_source.html | 2 +- doc/api/store_8hpp_source.html | 2 +- .../store__packet__variant_8hpp_source.html | 2 +- ...ore__packet__variant__fwd_8hpp_source.html | 2 +- doc/api/stream_8hpp_source.html | 2 +- doc/api/stream__traits_8hpp_source.html | 2 +- doc/api/string__view__helper_8hpp_source.html | 2 +- ..._endpoint_1_1rebind__executor-members.html | 2 +- ..._1basic__endpoint_1_1rebind__executor.html | 2 +- ...sync__mqtt_1_1basic__packet__id__type.html | 2 +- ...qtt_1_1client_1_1pubres__type-members.html | 2 +- ...async__mqtt_1_1client_1_1pubres__type.html | 2 +- ...1_1client_1_1rebind__executor-members.html | 2 +- ...c__mqtt_1_1client_1_1rebind__executor.html | 2 +- ...structasync__mqtt_1_1layer__customize.html | 2 +- ...tocol_00_01Executor_01_4_01_4-members.html | 2 +- ..._3_01Protocol_00_01Executor_01_4_01_4.html | 2 +- ...tream_3_01NextLayer_01_4_01_4-members.html | 2 +- ...ssl_1_1stream_3_01NextLayer_01_4_01_4.html | 2 +- ...tream_3_01NextLayer_01_4_01_4-members.html | 2 +- ...ket_1_1stream_3_01NextLayer_01_4_01_4.html | 2 +- ...uctasync__mqtt_1_1pub_1_1opts-members.html | 2 +- doc/api/structasync__mqtt_1_1pub_1_1opts.html | 2 +- ...uctasync__mqtt_1_1sub_1_1opts-members.html | 2 +- doc/api/structasync__mqtt_1_1sub_1_1opts.html | 2 +- doc/api/subopts_8hpp_source.html | 2 +- doc/api/topic__alias__recv_8hpp_source.html | 2 +- doc/api/topic__alias__send_8hpp_source.html | 2 +- doc/api/topic__sharename_8hpp_source.html | 2 +- doc/api/topic__subopts_8hpp_source.html | 2 +- doc/api/topics.html | 2 +- doc/api/utf8validate_8hpp_source.html | 2 +- doc/api/v3__1__1__connack_8hpp_source.html | 2 +- doc/api/v3__1__1__connect_8hpp_source.html | 2 +- doc/api/v3__1__1__disconnect_8hpp_source.html | 2 +- doc/api/v3__1__1__pingreq_8hpp_source.html | 2 +- doc/api/v3__1__1__pingresp_8hpp_source.html | 2 +- doc/api/v3__1__1__puback_8hpp_source.html | 2 +- doc/api/v3__1__1__pubcomp_8hpp_source.html | 2 +- doc/api/v3__1__1__publish_8hpp_source.html | 2 +- doc/api/v3__1__1__pubrec_8hpp_source.html | 2 +- doc/api/v3__1__1__pubrel_8hpp_source.html | 2 +- doc/api/v3__1__1__suback_8hpp_source.html | 2 +- doc/api/v3__1__1__subscribe_8hpp_source.html | 2 +- doc/api/v3__1__1__unsuback_8hpp_source.html | 2 +- .../v3__1__1__unsubscribe_8hpp_source.html | 2 +- doc/api/v5__auth_8hpp_source.html | 2 +- doc/api/v5__connack_8hpp_source.html | 2 +- doc/api/v5__connect_8hpp_source.html | 2 +- doc/api/v5__disconnect_8hpp_source.html | 2 +- doc/api/v5__pingreq_8hpp_source.html | 2 +- doc/api/v5__pingresp_8hpp_source.html | 2 +- doc/api/v5__puback_8hpp_source.html | 2 +- doc/api/v5__pubcomp_8hpp_source.html | 2 +- doc/api/v5__publish_8hpp_source.html | 2 +- doc/api/v5__pubrec_8hpp_source.html | 2 +- doc/api/v5__pubrel_8hpp_source.html | 2 +- doc/api/v5__suback_8hpp_source.html | 2 +- doc/api/v5__subscribe_8hpp_source.html | 2 +- doc/api/v5__unsuback_8hpp_source.html | 2 +- doc/api/v5__unsubscribe_8hpp_source.html | 2 +- doc/api/value__allocator_8hpp_source.html | 2 +- doc/api/variable__bytes_8hpp_source.html | 2 +- doc/api/will_8hpp_source.html | 2 +- doc/api/ws_8hpp_source.html | 2 +- doc/api/wss_8hpp_source.html | 2 +- doc/comparison.html | 2 +- 407 files changed, 933 insertions(+), 934 deletions(-) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index a051b2878..aff7bc9ba 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -1,8 +1,15 @@ :last-update-label!: = History -== 7.0.1 +== 8.0.0 +=== breaking changes +* `client` becomes `shared_ptr` similar as `endpoint`. #315 +** To create `client` instance, `client<...>::create(args)` similar as `endpoint`. +** This is required to keep client's lifetime during async operation is working. +** `client` and `endpoint` are consistent interface now. +=== other updates * Move endpoint definition (using) to endpoint_fwd.hpp #311, #312 +* install `*.ipp` files along with other header files #309 * Refined documents. #308 == 7.0.0 diff --git a/CMakeLists.txt b/CMakeLists.txt index c18535596..fb0b566bf 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,7 +5,7 @@ # http://www.boost.org/LICENSE_1_0.txt) cmake_minimum_required (VERSION 3.13.0) -project(async_mqtt_iface VERSION 7.0.1) +project(async_mqtt_iface VERSION 8.0.0) set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) @@ -136,7 +136,7 @@ if(DOXYGEN_FOUND) COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = async_mqtt" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile - COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NUMBER = 7.0.1" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NUMBER = 8.0.0" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "RECURSIVE = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "PREDEFINED = GENERATING_DOCUMENTATION ASYNC_MQTT_USE_TLS ASYNC_MQTT_USE_WS ASYNC_MQTT_USE_LOG" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include/async_mqtt" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile diff --git a/README.md b/README.md index d41609b37..86dc93f1b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Asynchronous MQTT communication library. -Version 7.0.1 [![Actions Status](https://github.com/redboltz/async_mqtt/workflows/CI/badge.svg)](https://github.com/redboltz/async_mqtt/actions)[![codecov](https://codecov.io/gh/redboltz/async_mqtt/branch/main/graph/badge.svg)](https://codecov.io/gh/redboltz/async_mqtt) +Version 8.0.0 [![Actions Status](https://github.com/redboltz/async_mqtt/workflows/CI/badge.svg)](https://github.com/redboltz/async_mqtt/actions)[![codecov](https://codecov.io/gh/redboltz/async_mqtt/branch/main/graph/badge.svg)](https://codecov.io/gh/redboltz/async_mqtt) This is Boost.Asio oriented asynchronous MQTT communication library. You can use async_mqtt to develop not only your MQTT client application but also your server (e.g. broker). Based on https://github.com/redboltz/mqtt_cpp experience, there are many improvements. See overview. diff --git a/doc/CHANGELOG.html b/doc/CHANGELOG.html index 13aafffde..6cd4608af 100644 --- a/doc/CHANGELOG.html +++ b/doc/CHANGELOG.html @@ -5,7 +5,7 @@ - + History