From a01dcd68a54d488fc8572448cd18d3583b4d8683 Mon Sep 17 00:00:00 2001 From: "Roger A. Light" Date: Thu, 20 May 2021 10:21:05 +0100 Subject: [PATCH] Document that bind_address can be NULL. --- include/mosquitto.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/include/mosquitto.h b/include/mosquitto.h index d74f496b..cb1786ef 100644 --- a/include/mosquitto.h +++ b/include/mosquitto.h @@ -508,7 +508,8 @@ libmosq_EXPORT int mosquitto_connect(struct mosquitto *mosq, const char *host, i * message to the client if no other messages have been exchanged * in that time. * bind_address - the hostname or ip address of the local network interface to - * bind to. + * bind to. If you do not want to bind to a specific interface, + * set this to NULL. * * Returns: * MOSQ_ERR_SUCCESS - on success. @@ -551,7 +552,8 @@ libmosq_EXPORT int mosquitto_connect_bind(struct mosquitto *mosq, const char *ho * message to the client if no other messages have been exchanged * in that time. * bind_address - the hostname or ip address of the local network interface to - * bind to. + * bind to. If you do not want to bind to a specific interface, + * set this to NULL. * properties - the MQTT 5 properties for the connect (not for the Will). * * Returns: @@ -626,7 +628,8 @@ libmosq_EXPORT int mosquitto_connect_async(struct mosquitto *mosq, const char *h * message to the client if no other messages have been exchanged * in that time. * bind_address - the hostname or ip address of the local network interface to - * bind to. + * bind to. If you do not want to bind to a specific interface, + * set this to NULL. * * Returns: * MOSQ_ERR_SUCCESS - on success. @@ -664,7 +667,8 @@ libmosq_EXPORT int mosquitto_connect_bind_async(struct mosquitto *mosq, const ch * message to the client if no other messages have been exchanged * in that time. * bind_address - the hostname or ip address of the local network interface to - * bind to. + * bind to. If you do not want to bind to a specific interface, + * set this to NULL. * * Returns: * MOSQ_ERR_SUCCESS - on success.