Skip to content

Commit 9502db0

Browse files
committed
add missing docs
1 parent 6e21c20 commit 9502db0

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

stackslib/src/config/mod.rs

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2370,12 +2370,17 @@ pub struct ConnectionOptionsFile {
23702370
pub soft_num_clients: Option<u64>,
23712371
/// maximum number of neighbors per host we permit
23722372
///
2373+
/// Default: 1.
23732374
/// Deprecated: it does not have any effect on the node's behavior.
23742375
pub max_neighbors_per_host: Option<u64>,
23752376
/// maximum number of inbound p2p connections per host we permit
2377+
///
2378+
/// Default: 4.
2379+
/// Deprecated: it does not have any effect on the node's behavior.
23762380
pub max_clients_per_host: Option<u64>,
23772381
/// soft limit on the number of neighbors per host we permit
23782382
///
2383+
/// Default: 1.
23792384
/// Deprecated: it does not have any effect on the node's behavior.
23802385
pub soft_max_neighbors_per_host: Option<u64>,
23812386
/// Soft limit on the number of outbound P2P connections per network organization (ASN).
@@ -2567,7 +2572,16 @@ pub struct ConnectionOptionsFile {
25672572
///
25682573
/// Default: `None` (feature disabled).
25692574
pub force_disconnect_interval: Option<u64>,
2570-
/// always push blocks, even if we're not NAT'ed
2575+
/// Controls whether a node with public inbound connections should still push blocks, even if not NAT'ed.
2576+
///
2577+
/// In the Stacks 2.x anti-entropy logic, if a node detected it had inbound connections
2578+
/// from public IPs (suggesting it wasn't behind NAT) and this flag was set to `false`,
2579+
/// it would refrain from proactively pushing blocks and microblocks to peers.
2580+
/// The assumption was that publicly reachable nodes should primarily serve downloads.
2581+
/// If set to `true` (default), the node would push data regardless of its perceived reachability.
2582+
///
2583+
/// Default: `true`.
2584+
/// Deprecated: This setting is ignored in Epoch 3.0+.
25712585
pub antientropy_public: Option<bool>,
25722586
/// Whether to allow connections and interactions with peers having private IP addresses.
25732587
///

0 commit comments

Comments
 (0)