Skip to content

Commit aa89e04

Browse files
committed
doc: document PeerManager::Options members
1 parent e35fb7b commit aa89e04

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/net_processing.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ class ChainstateManager;
1818
static constexpr bool DEFAULT_TXRECONCILIATION_ENABLE{false};
1919
/** Default for -maxorphantx, maximum number of orphan transactions kept in memory */
2020
static const unsigned int DEFAULT_MAX_ORPHAN_TRANSACTIONS = 100;
21-
/** Default number of orphan+recently-replaced txn to keep around for block reconstruction */
21+
/** Default number of non-mempool transactions to keep around for block reconstruction. Includes
22+
orphan, replaced, and rejected transactions. */
2223
static const unsigned int DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN = 100;
2324
static const bool DEFAULT_PEERBLOOMFILTERS = false;
2425
static const bool DEFAULT_PEERBLOCKFILTERS = false;
@@ -46,11 +47,16 @@ class PeerManager : public CValidationInterface, public NetEventsInterface
4647
{
4748
public:
4849
struct Options {
49-
/** Whether this node is running in -blocksonly mode */
50+
//! Whether this node is running in -blocksonly mode
5051
bool ignore_incoming_txs{DEFAULT_BLOCKSONLY};
52+
//! Whether transaction reconciliation protocol is enabled
5153
bool reconcile_txs{DEFAULT_TXRECONCILIATION_ENABLE};
54+
//! Maximum number of orphan transactions kept in memory
5255
uint32_t max_orphan_txs{DEFAULT_MAX_ORPHAN_TRANSACTIONS};
56+
//! Number of non-mempool transactions to keep around for block reconstruction. Includes
57+
//! orphan, replaced, and rejected transactions.
5358
size_t max_extra_txs{DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN};
59+
//! Whether all P2P messages are captured to disk
5460
bool capture_messages{false};
5561
};
5662

0 commit comments

Comments
 (0)