Skip to content

Commit 17e7054

Browse files
doc: clarify new_only param for Select function
Co-authored-by: Martin Zumsande <mzumsande@gmail.com>
1 parent b0010c8 commit 17e7054

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/addrman.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,9 @@ class AddrMan
146146
/**
147147
* Choose an address to connect to.
148148
*
149-
* @param[in] new_only Whether to only select addresses from the new table.
149+
* @param[in] new_only Whether to only select addresses from the new table. Passing `true` returns
150+
* 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).
150152
* @param[in] network Select only addresses of this network (nullopt = all)
151153
* @return CAddress The record for the selected peer.
152154
* seconds The last time we attempted to connect to that peer.

0 commit comments

Comments
 (0)