replace mosquitto_delay_puback() with MOSQ_OPT_DELAYED_ACK opt

Signed-off-by: Linus Basig <[email protected]>
Co-authored-by: Fabrizio Lazzaretti <[email protected]>
Signed-off-by: Fabrizio Lazzaretti <[email protected]>

Author: linuxbasic

ChangeLog.txt

@@ -1,5 +1,5 @@
 Client library:
-- Add `mosquitto_delay_puback()` for delaying the PUBACK message
+- Add `MOSQ_OPT_DELAYED_ACK` option to delaying the PUBACK message
   until the on_message callback returns.
 
 2.0.0 - 2020-12-03

include/mosquitto.h

@@ -131,6 +131,7 @@ enum mosq_opt_t {
 	MOSQ_OPT_TCP_NODELAY = 11,
 	MOSQ_OPT_BIND_ADDRESS = 12,
 	MOSQ_OPT_TLS_USE_OS_CERTS = 13,
+	MOSQ_OPT_DELAYED_ACK = 14,
 };
 
 
@@ -1467,6 +1468,9 @@ libmosq_EXPORT int mosquitto_opts_set(struct mosquitto *mosq, enum mosq_opt_t op
  *	MOSQ_OPT_TLS_USE_OS_CERTS - Set to 1 to instruct the client to load and
  *	          trust OS provided CA certificates for use with TLS connections.
  *	          Set to 0 (the default) to only use manually specified CA certs.
+ *
+ *	MOSQ_OPT_DELAYED_ACK - Set to 1 to instruct the client to acknowledge QoS 1
+ *            messages after the on_message callback is called.
  */
 libmosq_EXPORT int mosquitto_int_option(struct mosquitto *mosq, enum mosq_opt_t option, int value);
 
@@ -1665,22 +1669,6 @@ libmosq_EXPORT void mosquitto_user_data_set(struct mosquitto *mosq, void *obj);
  */
 libmosq_EXPORT void *mosquitto_userdata(struct mosquitto *mosq);
 
-/*
- * Function: mosquitto_delay_puback
- *
- * Per Default, the library will acknowledge a QoS 1 message before it calls the 
- * on_message callback. After <mosquitto_delay_puback> is called, the library
- * delays the acknowledgment until after the on_message callback has returned.
- *
- * Parameters:
- *  mosq - a valid mosquitto instance.
- *
- * Returns:
- *	MOSQ_ERR_SUCCESS - on success.
- * 	MOSQ_ERR_INVAL -   if the input parameters were invalid.
- */
-libmosq_EXPORT int mosquitto_delay_puback(struct mosquitto *mosq);
-
 
 /* ======================================================================
  *

lib/cpp/mosquittopp.cpp

@@ -352,11 +352,6 @@ void mosquittopp::user_data_set(void *userdata)
 	mosquitto_user_data_set(m_mosq, userdata);
 }
 
-int mosquittopp::delay_puback()
-{
-	mosquitto_delay_puback(m_mosq);
-}
-
 int mosquittopp::socks5_set(const char *host, int port, const char *username, const char *password)
 {
 	return mosquitto_socks5_set(m_mosq, host, port, username, password);

lib/cpp/mosquittopp.h

@@ -107,7 +107,6 @@ class mosqpp_EXPORT mosquittopp {
 		int max_inflight_messages_set(unsigned int max_inflight_messages);
 		void message_retry_set(unsigned int message_retry);
 		void user_data_set(void *userdata);
-		int delay_puback();
 		int tls_set(const char *cafile, const char *capath=NULL, const char *certfile=NULL, const char *keyfile=NULL, int (*pw_callback)(char *buf, int size, int rwflag, void *userdata)=NULL);
 		int tls_opts_set(int cert_reqs, const char *tls_version=NULL, const char *ciphers=NULL);
 		int tls_insecure_set(bool value);

lib/handle_publish.c

@@ -135,7 +135,7 @@ int handle__publish(struct mosquitto *mosq)
 			return MOSQ_ERR_SUCCESS;
 		case 1:
 			util__decrement_receive_quota(mosq);
-			if(!mosq->delayed_puback){
+			if(!mosq->delayed_ack){
 				rc = send__puback(mosq, mid, 0, NULL);
 			}
 			pthread_mutex_lock(&mosq->callback_mutex);
@@ -150,7 +150,7 @@ int handle__publish(struct mosquitto *mosq)
 				mosq->in_callback = false;
 			}
 			pthread_mutex_unlock(&mosq->callback_mutex);
-			if(mosq->delayed_puback){
+			if(mosq->delayed_ack){
 				rc = send__puback(mosq, mid, 0, NULL);
 			}
 			message__cleanup(&message);

lib/linker.version

@@ -141,8 +141,3 @@ MOSQ_1.7 {
 		mosquitto_property_next;
 		mosquitto_ssl_get;
 } MOSQ_1.6;
-
-MOSQ_2.1 {
-	global:
-		mosquitto_delay_puback;
-} MOSQ_1.7;

lib/mosquitto.c

@@ -193,7 +193,7 @@ int mosquitto_reinitialise(struct mosquitto *mosq, const char *id, bool clean_st
 	mosq->reconnect_delay_max = 1;
 	mosq->reconnect_exponential_backoff = false;
 	mosq->threaded = mosq_ts_none;
-	mosq->delayed_puback = false;
+	mosq->delayed_ack = false;
 #ifdef WITH_TLS
 	mosq->ssl = NULL;
 	mosq->ssl_ctx = NULL;

lib/mosquitto_internal.h

@@ -351,7 +351,7 @@ struct mosquitto {
 #ifdef WITH_EPOLL
 	uint32_t events;
 #endif
-	bool delayed_puback;
+	bool delayed_ack;
 };
 
 #define STREMPTY(str) (str[0] == '\0')

lib/options.c

@@ -486,6 +486,10 @@ int mosquitto_int_option(struct mosquitto *mosq, enum mosq_opt_t option, int val
 			mosq->tcp_nodelay = (bool)value;
 			break;
 
+		case MOSQ_OPT_DELAYED_ACK:
+			mosq->delayed_ack = (bool)value;
+			break;
+
 		default:
 			return MOSQ_ERR_INVAL;
 	}
@@ -530,12 +534,3 @@ void *mosquitto_userdata(struct mosquitto *mosq)
 {
 	return mosq->userdata;
 }
-
-int mosquitto_delay_puback(struct mosquitto *mosq)
-{
-	if(!mosq) return MOSQ_ERR_INVAL;
-
-	mosq->delayed_puback = true;
-	
-	return MOSQ_ERR_SUCCESS;
-}