Skip to content

Commit 7687707

Browse files
committed
doc: update Select function description
Capture potential performance slow down for `Select` by network & clarify return values.
1 parent 2b6bd12 commit 7687707

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/addrman.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,10 @@ class AddrMan
148148
*
149149
* @param[in] new_only Whether to only select addresses from the new table. Passing `true` returns
150150
* an address from the new table or an empty pair. Passing `false` will return an
151-
* address from either the new or tried table (it does not guarantee a tried entry).
152-
* @param[in] network Select only addresses of this network (nullopt = all)
151+
* empty pair or an address from either the new or tried table (it does not
152+
* guarantee a tried entry).
153+
* @param[in] network Select only addresses of this network (nullopt = all). Passing a network may
154+
* slow down the search.
153155
* @return CAddress The record for the selected peer.
154156
* seconds The last time we attempted to connect to that peer.
155157
*/

0 commit comments

Comments
 (0)