Skip to content

Commit

Permalink
Correct userdata_set to user_data_set
Browse files Browse the repository at this point in the history
Co-authored-by: jalotra <shivam.jalotra@flipkart.com>
Signed-off-by: Aarni Koskela <akx@iki.fi>
  • Loading branch information
akx and jalotra committed Jan 3, 2024
1 parent 0516ef1 commit fb418e1
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions src/paho/mqtt/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1838,7 +1838,7 @@ def on_log(self, func):
log_callback(client, userdata, level, buf)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
level: gives the severity of the message and will be one of
MQTT_LOG_INFO, MQTT_LOG_NOTICE, MQTT_LOG_WARNING,
MQTT_LOG_ERR, and MQTT_LOG_DEBUG.
Expand Down Expand Up @@ -1869,7 +1869,7 @@ def on_pre_connect(self, func):
connect_callback(client, userdata)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
Decorator: @client.pre_connect_callback() (```client``` is the name of the
instance which this callback is being attached to)
Expand Down Expand Up @@ -1901,7 +1901,7 @@ def on_connect(self, func):
connect_callback(client, userdata, flags, reasonCode, properties)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
flags: response flags sent by the broker
rc: the connection result
reasonCode: the MQTT v5.0 reason code: an instance of the ReasonCode class.
Expand Down Expand Up @@ -1954,7 +1954,7 @@ def on_connect_fail(self, func):
on_connect_fail(client, userdata)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
Decorator: @client.connect_fail_callback() (```client``` is the name of the
instance which this callback is being attached to)
Expand Down Expand Up @@ -1986,7 +1986,7 @@ def on_subscribe(self, func):
subscribe_callback(client, userdata, mid, reasonCodes, properties)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
mid: matches the mid variable returned from the corresponding
subscribe() call.
granted_qos: list of integers that give the QoS level the broker has
Expand Down Expand Up @@ -2026,7 +2026,7 @@ def on_message(self, func):
on_message_callback(client, userdata, message)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
message: an instance of MQTTMessage.
This is a class with members topic, payload, qos, retain.
Expand Down Expand Up @@ -2063,7 +2063,7 @@ def on_publish(self, func):
on_publish_callback(client, userdata, mid)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
mid: matches the mid variable returned from the corresponding
publish() call, to allow outgoing messages to be tracked.
Expand Down Expand Up @@ -2097,7 +2097,7 @@ def on_unsubscribe(self, func):
unsubscribe_callback(client, userdata, mid, properties, reasonCodes)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
mid: matches the mid variable returned from the corresponding
unsubscribe() call.
properties: the MQTT v5.0 properties received from the broker. A
Expand Down Expand Up @@ -2134,7 +2134,7 @@ def on_disconnect(self, func):
disconnect_callback(client, userdata, reasonCode, properties)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
rc: the disconnection result
The rc parameter indicates the disconnection state. If
MQTT_ERR_SUCCESS (0), the callback was called in response to
Expand Down Expand Up @@ -2169,7 +2169,7 @@ def on_socket_open(self, func):
socket_open_callback(client, userdata, socket)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
sock: the socket which was just opened.
Decorator: @client.socket_open_callback() (```client``` is the name of the
Expand Down Expand Up @@ -2214,7 +2214,7 @@ def on_socket_close(self, func):
socket_close_callback(client, userdata, socket)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
sock: the socket which is about to be closed.
Decorator: @client.socket_close_callback() (```client``` is the name of the
Expand Down Expand Up @@ -2259,7 +2259,7 @@ def on_socket_register_write(self, func):
socket_register_write_callback(client, userdata, socket)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
sock: the socket which should be registered for writing
Decorator: @client.socket_register_write_callback() (```client``` is the name of the
Expand Down Expand Up @@ -2307,7 +2307,7 @@ def on_socket_unregister_write(self, func):
socket_unregister_write_callback(client, userdata, socket)
client: the client instance for this callback
userdata: the private user data as set in Client() or userdata_set()
userdata: the private user data as set in Client() or user_data_set()
sock: the socket which should be unregistered for writing
Decorator: @client.socket_unregister_write_callback() (```client``` is the name of the
Expand Down

0 comments on commit fb418e1

Please sign in to comment.