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 8ec7b50835fedbadb94704a871689ebffc7dc471..c6cb86c6bc6192c308037f5ccca5578de9c8fa66 100644 (file)
--- a/src/meshlink.h
+++ b/src/meshlink.h
@@ -730,7 +730,9 @@ extern int meshlink_get_port(meshlink_handle_t *mesh);
  *                       If the port is set to 0, then MeshLink will listen on a port
  *                       that is randomly assigned by the operating system every time meshlink_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.
  */
 
 extern bool meshlink_set_port(meshlink_handle_t *mesh, int port);