docs: improve docs where MemPoolLimits is used

This commit is contained in:
stickies-v committed 2022-10-05 13:09:08 +01:00
1 parent 6945853c0b
commit 33b12e5df6
1 file changed
+23 -9
+23 -9
View File
@@ -547,10 +547,16 @@ private:
/** /**
* Helper function to calculate all in-mempool ancestors of staged_ancestors and apply ancestor * Helper function to calculate all in-mempool ancestors of staged_ancestors and apply ancestor
* and descendant limits (including staged_ancestors thsemselves, entry_size and entry_count). * and descendant limits (including staged_ancestors thsemselves, entry_size and entry_count).
* param@[in] entry_size Virtual size to include in the limits. *
* param@[in] entry_count How many entries to include in the limits. * @param[in] entry_size Virtual size to include in the limits.
* param@[in] staged_ancestors Should contain entries in the mempool. * @param[in] entry_count How many entries to include in the limits.
* param@[out] setAncestors Will be populated with all mempool ancestors. * @param[out] setAncestors Will be populated with all mempool ancestors.
* @param[in] staged_ancestors Should contain entries in the mempool.
* @param[in] limits Maximum number and size of ancestors and descendants
* @param[out] errString Populated with error reason if any limits are hit
*
* @return true if no limits were hit and all in-mempool ancestors were calculated, false
* otherwise
*/ */
bool CalculateAncestorsAndCheckLimits(size_t entry_size, bool CalculateAncestorsAndCheckLimits(size_t entry_size,
size_t entry_count, size_t entry_count,
@@ -665,12 +671,20 @@ public:
*/ */
void UpdateTransactionsFromBlock(const std::vector<uint256>& vHashesToUpdate) EXCLUSIVE_LOCKS_REQUIRED(cs, cs_main) LOCKS_EXCLUDED(m_epoch); void UpdateTransactionsFromBlock(const std::vector<uint256>& vHashesToUpdate) EXCLUSIVE_LOCKS_REQUIRED(cs, cs_main) LOCKS_EXCLUDED(m_epoch);
/** Try to calculate all in-mempool ancestors of entry. /**
* Try to calculate all in-mempool ancestors of entry.
* (these are all calculated including the tx itself) * (these are all calculated including the tx itself)
* limits = maximum number and size of ancestors and descendants *
* errString = populated with error reason if any limits are hit * @param[in] entry CTxMemPoolEntry of which all in-mempool ancestors are calculated
* fSearchForParents = whether to search a tx's vin for in-mempool parents, or * @param[out] setAncestors Will be populated with all mempool ancestors.
* look up parents from mapLinks. Must be true for entries not in the mempool * @param[in] limits Maximum number and size of ancestors and descendants
* @param[out] errString Populated with error reason if any limits are hit
* @param[in] fSearchForParents Whether to search a tx's vin for in-mempool parents, or look
* up parents from mapLinks. Must be true for entries not in
* the mempool
*
* @return true if no limits were hit and all in-mempool ancestors were calculated, false
* otherwise
*/ */
bool CalculateMemPoolAncestors(const CTxMemPoolEntry& entry, bool CalculateMemPoolAncestors(const CTxMemPoolEntry& entry,
setEntries& setAncestors, setEntries& setAncestors,