From 768770771f7db60147943152b34a8dd485cdcc76 Mon Sep 17 00:00:00 2001 From: Amiti Uttarwar Date: Tue, 25 Apr 2023 16:42:36 +0100 Subject: doc: update `Select` function description Capture potential performance slow down for `Select` by network & clarify return values. --- src/addrman.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'src/addrman.h') 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. */ -- cgit v1.2.3