Make meshlink_set_port() return false if we didn't bind to the requested port.

[meshlink] / src / meshlink++.h

diff --git a/src/meshlink++.h b/src/meshlink++.h
index 48eabf3fbf5fdf80cfb3586c6a5001e808a7e208..8287e0382632777df5d4c0f1a7e59d4c398259ad 100644 (file)
--- a/src/meshlink++.h
+++ b/src/meshlink++.h
@@ -533,7 +533,9 @@ public:
         *                       If the port is set to 0, then MeshLink will listen on a port
         *                       that is randomly assigned by the operating system every time open() is called.
         *
-        *  @return              This function returns true if the port was successfully changed, false otherwise.
+        *  @return              This function returns true if the port was successfully changed
+        *                       to the desired port, false otherwise. If it returns false, there
+        *                       is no guarantee that MeshLink is listening on the old port.
         */
        bool set_port(int port) {
                return meshlink_set_port(handle, port);