From: Matt Corallo <git@bluematt.me>
Date: Tue, 9 Aug 2022 21:45:19 +0000 (+0000)
Subject: Clarify comment on BUFFER_DRAIN_MSGS_PER_TICK.
X-Git-Tag: v0.0.111~37^2~3
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=4f6da92c4e1f42259fbc01aee1812a2fdd9d8638;p=rust-lightning

Clarify comment on BUFFER_DRAIN_MSGS_PER_TICK.
---

diff --git a/lightning/src/ln/peer_handler.rs b/lightning/src/ln/peer_handler.rs
index 6c9a608b6..165d607f1 100644
--- a/lightning/src/ln/peer_handler.rs
+++ b/lightning/src/ln/peer_handler.rs
@@ -323,6 +323,10 @@ const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
 /// process before the next ping.
+///
+/// Note that we continue responding to other messages even after we've sent this many messages, so
+/// it's more of a general guideline used for gossip backfill (and gossip forwarding, times
+/// [`FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO`]) than a hard limit.
 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
 
 struct Peer {