OnClientError comment - clarify that this can be called multiple times.

Ref eclipse-paho#254
ChIoT-Tech · Nov 13, 2024 · 927de5f · 927de5f
1 parent 7474a8a
commit 927de5f
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/paho/client.go b/paho/client.go
@@ -91,7 +91,8 @@ type (
 		PacketTimeout time.Duration
 		// OnServerDisconnect is called only when a packets.DISCONNECT is received from server
 		OnServerDisconnect func(*Disconnect)
-		// OnClientError is for example called on net.Error
+		// OnClientError is for example called on net.Error. Note that this may be called multiple times and may be
+		// called following a successful `Disconnect`. See autopaho.errorHandler for an example.
 		OnClientError func(error)
 		// PublishHook allows a user provided function to be called before
 		// a Publish packet is sent allowing it to inspect or modify the