34#ifndef __mqtt_async_client_h
35#define __mqtt_async_client_h
66#if defined(PAHO_MQTTPP_VERSIONS)
68const uint32_t PAHO_MQTTPP_VERSION = 0x01050002;
70const string PAHO_MQTTPP_VERSION_STR(
"Paho MQTT C++ (mqttpp) v. 1.5.2");
72const string PAHO_MQTTPP_COPYRIGHT(
"Copyright (c) 2013-2025 Frank Pagliughi");
79const string COPYRIGHT(
"Copyright (c) 2013-2025 Frank Pagliughi");
140 using ptr_t = std::shared_ptr<async_client>;
155 using guard = std::unique_lock<std::mutex>;
157 using unique_lock = std::unique_lock<std::mutex>;
160 mutable std::mutex lock_;
168 std::unique_ptr<MQTTClient_persistence> persist_{};
182 connect_options connOpts_;
186 std::list<token_ptr> pendingTokens_;
188 std::list<delivery_token_ptr> pendingDeliveryTokens_;
193 static void on_connected(
void* context,
char* cause);
194 static void on_connection_lost(
void* context,
char* cause);
195 static void on_disconnected(
196 void* context, MQTTProperties* cprops, MQTTReasonCodes reasonCode
198 static int on_message_arrived(
199 void* context,
char* topicName,
int topicLen, MQTTAsync_message* msg
201 static void on_delivery_complete(
void* context, MQTTAsync_token tok);
202 static int on_update_connection(
void* context, MQTTAsync_connectData* cdata);
208 virtual void remove_token(
token* tok)
override;
209 virtual void remove_token(
token_ptr tok) { remove_token(tok.get()); }
213 async_client() =
delete;
214 async_client(
const async_client&) =
delete;
215 async_client& operator=(
const async_client&) =
delete;
218 static void check_ret(
int rc) {
219 if (rc != MQTTASYNC_SUCCESS)
244 const string& serverURI,
const string& clientId =
string{},
247 : createOpts_{serverURI, clientId, persistence} {
264 const string& serverURI,
const string& clientId,
int maxBufferedMessages,
267 : createOpts_{serverURI, clientId, maxBufferedMessages, persistence} {
283 const string& serverURI,
const string& clientId,
const create_options& opts,
286 : createOpts_{serverURI, clientId, opts, persistence} {
436 template <
class Rep,
class Period>
470 template <
class Rep,
class Period>
472 const std::chrono::duration<Rep, Period>& timeout,
void* userContext,
549 string_ref topic,
const void* payload,
size_t n,
int qos,
bool retained,
608 string_ref topic,
const void* payload,
size_t n,
int qos,
bool retained,
645 const string& topicFilter,
int qos,
667 const string& topicFilter,
int qos,
void* userContext,
iaction_listener& cb,
687 const std::vector<subscribe_options>& opts = std::vector<subscribe_options>(),
710 const std::vector<subscribe_options>& opts = std::vector<subscribe_options>(),
851 template <
typename Rep,
class Period>
853 event* evt,
const std::chrono::duration<Rep, Period>& relTime
859 return que_->try_get_for(evt, relTime);
872 template <
typename Rep,
class Period>
876 que_->try_get_for(&evt, relTime);
890 template <
class Clock,
class Duration>
892 event* evt,
const std::chrono::time_point<Clock, Duration>& absTime
898 return que_->try_get_until(evt, absTime);
911 template <
class Clock,
class Duration>
915 que_->try_get_until(&evt, absTime);
943 template <
typename Rep,
class Period>
956 if (
const auto* pval = evt.get_message_if()) {
957 *msg = std::move(*pval);
961 if (evt.is_any_disconnect()) {
974 template <
typename Rep,
class Period>
976 const std::chrono::duration<Rep, Period>& relTime
989 template <
class Clock,
class Duration>
1002 if (
const auto* pval = evt.get_message_if()) {
1003 *msg = std::move(*pval);
1007 if (!evt.is_any_disconnect()) {
1020 template <
class Clock,
class Duration>
1022 const std::chrono::time_point<Clock, Duration>& absTime
Definition async_client.h:137
void set_connection_lost_handler(connection_handler cb)
bool try_consume_event_until(event *evt, const std::chrono::time_point< Clock, Duration > &absTime)
Definition async_client.h:891
delivery_token_ptr publish(const_message_ptr msg, void *userContext, iaction_listener &cb) override
bool consumer_done() noexcept override
Definition async_client.h:820
std::unique_ptr< thread_queue< event > > consumer_queue_type
Definition async_client.h:142
void set_disconnected_handler(disconnected_handler cb)
const_message_ptr try_consume_message_until(const std::chrono::time_point< Clock, Duration > &absTime)
Definition async_client.h:1021
token_ptr subscribe(const string &topicFilter, int qos, const subscribe_options &opts=subscribe_options(), const properties &props=properties()) override
token_ptr disconnect(disconnect_options opts) override
bool try_consume_message(const_message_ptr *msg) override
token_ptr disconnect() override
Definition async_client.h:404
delivery_token_ptr publish(string_ref topic, const void *payload, size_t n, int qos, bool retained, void *userContext, iaction_listener &cb) override
delivery_token_ptr publish(string_ref topic, const void *payload, size_t n) override
Definition async_client.h:560
delivery_token_ptr publish(string_ref topic, binary_ref payload, int qos, bool retained, const properties &props=properties()) override
token_ptr subscribe(const string &topicFilter, int qos, void *userContext, iaction_listener &cb, const subscribe_options &opts=subscribe_options(), const properties &props=properties()) override
std::shared_ptr< async_client > ptr_t
Definition async_client.h:140
bool consumer_closed() noexcept override
Definition async_client.h:812
void stop_consuming() override
connect_options get_connect_options() const
Definition async_client.h:527
bool try_consume_message_for(const_message_ptr *msg, const std::chrono::duration< Rep, Period > &relTime)
Definition async_client.h:944
token_ptr disconnect(int timeout) override
Definition async_client.h:423
token_ptr subscribe(const_string_collection_ptr topicFilters, const qos_collection &qos, const std::vector< subscribe_options > &opts=std::vector< subscribe_options >(), const properties &props=properties()) override
std::function< bool(connect_data &)> update_connection_handler
Definition async_client.h:151
void set_message_callback(message_handler cb)
token_ptr disconnect(const std::chrono::duration< Rep, Period > &timeout, void *userContext, iaction_listener &cb)
Definition async_client.h:471
token_ptr connect(connect_options options, void *userContext, iaction_listener &cb) override
delivery_token_ptr publish(string_ref topic, const void *payload, size_t n, int qos, bool retained, const properties &props=properties()) override
std::function< void(const properties &, ReasonCode)> disconnected_handler
Definition async_client.h:149
std::function< void(const_message_ptr)> message_handler
Definition async_client.h:145
std::size_t consumer_queue_size() const override
Definition async_client.h:829
async_client(const string &serverURI, const string &clientId, int maxBufferedMessages, const persistence_type &persistence=NO_PERSISTENCE)
Definition async_client.h:263
token_ptr unsubscribe(const string &topicFilter, const properties &props=properties()) override
delivery_token_ptr publish(string_ref topic, binary_ref payload) override
Definition async_client.h:587
string get_client_id() const override
Definition async_client.h:506
void set_callback(callback &cb) override
bool try_consume_message_until(const_message_ptr *msg, const std::chrono::time_point< Clock, Duration > &absTime)
Definition async_client.h:990
token_ptr subscribe(const_string_collection_ptr topicFilters, const qos_collection &qos, void *userContext, iaction_listener &cb, const std::vector< subscribe_options > &opts=std::vector< subscribe_options >(), const properties &props=properties()) override
const_message_ptr consume_message() override
token_ptr reconnect() override
const_message_ptr try_consume_message_for(const std::chrono::duration< Rep, Period > &relTime)
Definition async_client.h:975
void set_connected_handler(connection_handler cb)
bool try_consume_event_for(event *evt, const std::chrono::duration< Rep, Period > &relTime)
Definition async_client.h:852
async_client(const create_options &opts)
Definition async_client.h:297
token_ptr disconnect(int timeout, void *userContext, iaction_listener &cb) override
std::vector< delivery_token_ptr > get_pending_delivery_tokens() const override
token_ptr unsubscribe(const_string_collection_ptr topicFilters, const properties &props=properties()) override
token_ptr unsubscribe(const_string_collection_ptr topicFilters, void *userContext, iaction_listener &cb, const properties &props=properties()) override
void clear_consumer() override
Definition async_client.h:801
bool try_consume_event(event *evt) override
int mqtt_version() const noexcept
Definition async_client.h:521
token_ptr unsubscribe(const string &topicFilter, void *userContext, iaction_listener &cb, const properties &props=properties()) override
event try_consume_event_until(const std::chrono::time_point< Clock, Duration > &absTime)
Definition async_client.h:912
event consume_event() override
string get_server_uri() const override
Definition async_client.h:511
token_ptr disconnect(const std::chrono::duration< Rep, Period > &timeout)
Definition async_client.h:437
delivery_token_ptr get_pending_delivery_token(int msgID) const override
token_ptr disconnect(void *userContext, iaction_listener &cb) override
Definition async_client.h:489
token_ptr connect(void *userContext, iaction_listener &cb) override
Definition async_client.h:389
void disable_callbacks() override
async_client(const string &serverURI, const string &clientId=string{}, const persistence_type &persistence=NO_PERSISTENCE)
Definition async_client.h:243
void set_update_connection_handler(update_connection_handler cb)
token_ptr connect() override
bool is_connected() const override
Definition async_client.h:535
event try_consume_event_for(const std::chrono::duration< Rep, Period > &relTime)
Definition async_client.h:873
delivery_token_ptr publish(const_message_ptr msg) override
void start_consuming() override
token_ptr connect(connect_options options) override
async_client(const string &serverURI, const string &clientId, const create_options &opts, const persistence_type &persistence=NO_PERSISTENCE)
Definition async_client.h:282
std::function< void(const string &cause)> connection_handler
Definition async_client.h:147
Definition connect_options.h:571
Definition connect_options.h:50
Definition create_options.h:77
const string & get_server_uri() const noexcept
Definition create_options.h:205
const string & get_client_id() const noexcept
Definition create_options.h:215
Definition disconnect_options.h:41
Definition exception.h:48
Definition iaction_listener.h:50
Definition iasync_client.h:60
std::vector< int > qos_collection
Definition iasync_client.h:66
static constexpr bool DFLT_RETAINED
Definition message.h:62
static constexpr int DFLT_QOS
Definition message.h:60
Definition properties.h:293
Definition thread_queue.h:43
Definition subscribe_options.h:49
Definition async_client.h:60
ReasonCode
Definition reason_code.h:39
const string COPYRIGHT("Copyright (c) 2013-2025 Frank Pagliughi")
constexpr no_persistence NO_PERSISTENCE
Definition create_options.h:43
string_collection::const_ptr_t const_string_collection_ptr
Definition string_collection.h:259
bool to_bool(int n)
Definition types.h:107
token::ptr_t token_ptr
Definition token.h:513
const uint32_t VERSION
Definition async_client.h:75
message::const_ptr_t const_message_ptr
Definition message.h:372
const string VERSION_STR("Paho MQTT C++ (mqttpp) v. 1.5.2")
long to_milliseconds_count(const std::chrono::duration< Rep, Period > &dur)
Definition types.h:95
delivery_token::ptr_t delivery_token_ptr
Definition delivery_token.h:127
async_client::ptr_t async_client_ptr
Definition async_client.h:1031
std::variant< no_persistence, string, iclient_persistence * > persistence_type
Definition create_options.h:53