aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAmiti Uttarwar <amiti@uttarwar.org>2023-04-25 16:42:36 +0100
committerAmiti Uttarwar <amiti@uttarwar.org>2023-05-24 12:03:18 -0700
commit768770771f7db60147943152b34a8dd485cdcc76 (patch)
tree1afcf3270a703240be42d8943652ebdd244ce02e
parent2b6bd12eea0c970881753124ec3f0a67e2de8e17 (diff)
doc: update `Select` function description
Capture potential performance slow down for `Select` by network & clarify return values.
-rw-r--r--src/addrman.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/addrman.h b/src/addrman.h
index 6284b80a52..f41687dcff 100644
--- a/src/addrman.h
+++ b/src/addrman.h
@@ -148,8 +148,10 @@ public:
*
* @param[in] new_only Whether to only select addresses from the new table. Passing `true` returns
* an address from the new table or an empty pair. Passing `false` will return an
- * address from either the new or tried table (it does not guarantee a tried entry).
- * @param[in] network Select only addresses of this network (nullopt = all)
+ * empty pair or an address from either the new or tried table (it does not
+ * guarantee a tried entry).
+ * @param[in] network Select only addresses of this network (nullopt = all). Passing a network may
+ * slow down the search.
* @return CAddress The record for the selected peer.
* seconds The last time we attempted to connect to that peer.
*/