Document tls:// prefix

Signed-off-by: Konstantin Tyurin <konstantin@pluraf.com>
This commit is contained in:
Konstantin Tyurin 2025-11-13 15:19:46 +01:00 committed by Ian Craggs
parent 86b11bd556
commit e8b6b3742a
No known key found for this signature in database
GPG Key ID: A7AE1A8F2CCAB186
2 changed files with 7 additions and 7 deletions

View File

@ -918,13 +918,13 @@ LIBMQTT_API int MQTTAsync_reconnect(MQTTAsync handle);
* <br>
* @em tcp:// or @em mqtt:// - Insecure TCP
* <br>
* @em ssl:// or @em mqtts:// - Encrypted SSL/TLS
* @em ssl:// or @em tls:// or @em mqtts:// - Encrypted SSL/TLS
* <br>
* @em ws:// - Insecure websockets
* <br>
* @em wss:// - Secure web sockets
* <br>
* The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS
* The TLS enabled prefixes (ssl, tls, mqtts, wss) are only valid if a TLS
* version of the library is linked with.
* For <i>host</i>, you can specify either an IP address or a host name. For
* instance, to connect to a server running on the local machines with the
@ -1311,8 +1311,8 @@ typedef struct
/**
* An array of null-terminated strings specifying the servers to
* which the client will connect. Each string takes the form <i>protocol://host:port</i>.
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>.
* The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>tls</i>, <i>ws</i> or <i>wss</i>.
* The TLS enabled prefixes (ssl, tls, wss) are only valid if a TLS version of the library
* is linked with.
* For <i>host</i>, you can
* specify either an IP address or a domain name. For instance, to connect to

View File

@ -508,13 +508,13 @@ LIBMQTT_API int MQTTClient_setPublished(MQTTClient handle, void* context, MQTTCl
* <br>
* @em tcp:// or @em mqtt:// - Insecure TCP
* <br>
* @em ssl:// or @em mqtts:// - Encrypted SSL/TLS
* @em ssl:// or @em tls:// or @em mqtts:// - Encrypted SSL/TLS
* <br>
* @em ws:// - Insecure websockets
* <br>
* @em wss:// - Secure web sockets
* <br>
* The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS
* The TLS enabled prefixes (ssl, tls, mqtts, wss) are only valid if a TLS
* version of the library is linked with.
* For <i>host</i>, you can specify either an IP address or a host name. For
* instance, to connect to a server running on the local machines with the
@ -927,7 +927,7 @@ typedef struct
* An optional array of null-terminated strings specifying the servers to
* which the client will connect. Each string takes the form <i>protocol://host:port</i>.
* <i>protocol</i> must be <i>tcp</i>, <i>ssl</i>, <i>ws</i> or <i>wss</i>.
* The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library
* The TLS enabled prefixes (ssl, tls, wss) are only valid if a TLS version of the library
* is linked with.
* For <i>host</i>, you can
* specify either an IP address or a host name. For instance, to connect to