X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink%2B%2B.h;h=258d6cf49b796b75c42bb3194509223af6d2497d;hb=6c8d95b21e5e879bf5760a24dc17b28e489bf2ce;hp=6acfe251dfe1be60b2c342221836abf172987e2e;hpb=2de31bfc1a24d6643763f6ef1bbda2948ec46f3a;p=meshlink

diff --git a/src/meshlink++.h b/src/meshlink++.h
index 6acfe251..258d6cf4 100644
--- a/src/meshlink++.h
+++ b/src/meshlink++.h
@@ -354,6 +354,10 @@ namespace meshlink {
 		 *  Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
 		 *  there is no guarantee that the external address will be valid for an extended period of time.
 		 *
+		 *  This function is blocking. It can take several seconds before it returns.
+		 *  There is no guarantee it will be able to resolve the external address.
+		 *  Failures might be because by temporary network outages.
+		 *
 		 *  @return             This function returns a pointer to a C string containing the discovered external address,
 		 *                      or NULL if there was an error looking up the address.
 		 *                      After get_external_address() returns, the application is free to overwrite or free this string.
@@ -424,6 +428,12 @@ namespace meshlink {
 		 *  An invitation can only be used if the local node has never connected to other nodes before.
 		 *  After a succesfully accepted invitation, the name of the local node may have changed.
 		 *
+		 *  This function may only be called on a mesh that has not been started yet and which is not already part of an existing mesh.
+		 *
+		 *  This function is blocking. It can take several seconds before it returns.
+		 *  There is no guarantee it will perform a successful join.
+		 *  Failures might be caused by temporary network outages, or by the invitation having expired.
+		 *
 		 *  @param invitation   A string containing the invitation URL.
 		 *
 		 *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.