diff options
| author | Amiti Uttarwar <amiti@uttarwar.org> | 2023-03-10 18:25:59 -0800 |
|---|---|---|
| committer | Amiti Uttarwar <amiti@uttarwar.org> | 2023-03-17 18:02:40 -0700 |
| commit | 17e705428ddf80c7a7f31fe5430d966cf08a37d6 (patch) | |
| tree | 3de128a1f9eb391288f5a61e93d7f94ec3379357 /src/addrman.h | |
| parent | b0010c83a1b4a3d21719cb68e37faf9b1172522a (diff) | |
| download | bitcoin-17e705428ddf80c7a7f31fe5430d966cf08a37d6.tar.xz | |
doc: clarify new_only param for Select function
Co-authored-by: Martin Zumsande <mzumsande@gmail.com>
Diffstat (limited to 'src/addrman.h')
| -rw-r--r-- | src/addrman.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/addrman.h b/src/addrman.h index c8e31fe283..6284b80a52 100644 --- a/src/addrman.h +++ b/src/addrman.h @@ -146,7 +146,9 @@ public: /** * Choose an address to connect to. * - * @param[in] new_only Whether to only select addresses from the new table. + * @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) * @return CAddress The record for the selected peer. * seconds The last time we attempted to connect to that peer. |