X-Git-Url: https://git.distorted.org.uk/~mdw/secnet/blobdiff_plain/f6eff504840a1e9cc80edd34f8d0e328b9e170c9..855fb0668edd2cf85253f81408f4558e0f4a0bd8:/secnet.h

diff --git a/secnet.h b/secnet.h
index 6b20045..28aff0f 100644
--- a/secnet.h
+++ b/secnet.h
@@ -338,6 +338,9 @@ typedef void comm_release_notify_fn(void *commst, void *nst,
 				    comm_notify_fn *fn);
 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
 			       const struct comm_addr *dest);
+  /* Only returns false if (we know that) the local network
+   * environment is such that this address cannot work; transient
+   * or unknown/unexpected failures return true. */
 typedef const char *comm_addr_to_string_fn(void *commst,
 					   const struct comm_addr *ca);
         /* Returned string is in a static buffer. */