Skip to content

Commit

Permalink
[addrman] Add doxygen comment to AddrMan::Add()
Browse files Browse the repository at this point in the history
Does not document the return value since we're going to fix the
semantics in a future commit.
  • Loading branch information
jnewbery committed Oct 28, 2021
1 parent ab25ef8 commit e58598e
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/addrman.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,14 @@ class AddrMan
//! Return the number of (unique) addresses in all tables.
size_t size() const;

//! Add addresses to addrman's new table.
/**
* Attempt to add one or more addresses to addrman's new table.
*
* @param[in] vAddr Address records to attempt to add.
* @param[in] source The address of the node that sent us these addr records.
* @param[in] nTimePenalty A "time penalty" to apply to the address record's nTime. If a peer
* sends us an address record with nTime=n, then we'll add it to our
* addrman with nTime=(n - nTimePenalty). */
bool Add(const std::vector<CAddress>& vAddr, const CNetAddr& source, int64_t nTimePenalty = 0);

//! Mark an entry as accessible, possibly moving it from "new" to "tried".
Expand Down

0 comments on commit e58598e

Please sign in to comment.