github
/
mosquitto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2621 from CastleOnTheHill/master

Browse Source 
Fix comments errors, it is the client that sends PING to broker actively
pull/2683/head
Roger Light 3 years ago committed by GitHub
parent 5c3c5d779f dcad2e410a
commit d4e69c41bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File

24
include/mosquitto.h
Unescape Escape View File

@ -497,8 +497,8 @@ libmosq_EXPORT int mosquitto_username_pw_set(struct mosquitto *mosq, const char
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname or ip address of the broker to connect to. * host - the hostname or ip address of the broker to connect to.
* port - the network port to connect to. Usually 1883. * port - the network port to connect to. Usually 1883.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* *
* Returns: * Returns:
@ -529,8 +529,8 @@ libmosq_EXPORT int mosquitto_connect(struct mosquitto *mosq, const char *host, i
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname or ip address of the broker to connect to. * host - the hostname or ip address of the broker to connect to.
* port - the network port to connect to. Usually 1883. * port - the network port to connect to. Usually 1883.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* bind_address - the hostname or ip address of the local network interface to * bind_address - the hostname or ip address of the local network interface to
* bind to. If you do not want to bind to a specific interface, * bind to. If you do not want to bind to a specific interface,
@ -573,8 +573,8 @@ libmosq_EXPORT int mosquitto_connect_bind(struct mosquitto *mosq, const char *ho
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname or ip address of the broker to connect to. * host - the hostname or ip address of the broker to connect to.
* port - the network port to connect to. Usually 1883. * port - the network port to connect to. Usually 1883.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* bind_address - the hostname or ip address of the local network interface to * bind_address - the hostname or ip address of the local network interface to
* bind to. If you do not want to bind to a specific interface, * bind to. If you do not want to bind to a specific interface,
@ -614,8 +614,8 @@ libmosq_EXPORT int mosquitto_connect_bind_v5(struct mosquitto *mosq, const char
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname or ip address of the broker to connect to. * host - the hostname or ip address of the broker to connect to.
* port - the network port to connect to. Usually 1883. * port - the network port to connect to. Usually 1883.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* *
* Returns: * Returns:
@ -649,8 +649,8 @@ libmosq_EXPORT int mosquitto_connect_async(struct mosquitto *mosq, const char *h
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname or ip address of the broker to connect to. * host - the hostname or ip address of the broker to connect to.
* port - the network port to connect to. Usually 1883. * port - the network port to connect to. Usually 1883.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* bind_address - the hostname or ip address of the local network interface to * bind_address - the hostname or ip address of the local network interface to
* bind to. If you do not want to bind to a specific interface, * bind to. If you do not want to bind to a specific interface,
@ -688,8 +688,8 @@ libmosq_EXPORT int mosquitto_connect_bind_async(struct mosquitto *mosq, const ch
* Parameters: * Parameters:
* mosq - a valid mosquitto instance. * mosq - a valid mosquitto instance.
* host - the hostname to search for an SRV record. * host - the hostname to search for an SRV record.
* keepalive - the number of seconds after which the broker should send a PING * keepalive - the number of seconds after which the client should send a PING
* message to the client if no other messages have been exchanged * message to the broker if no other messages have been exchanged
* in that time. * in that time.
* bind_address - the hostname or ip address of the local network interface to * bind_address - the hostname or ip address of the local network interface to
* bind to. If you do not want to bind to a specific interface, * bind to. If you do not want to bind to a specific interface,

Write Preview
Loading…
Cancel
Save