]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Clarify comment on BUFFER_DRAIN_MSGS_PER_TICK.
authorMatt Corallo <git@bluematt.me>
Tue, 9 Aug 2022 21:45:19 +0000 (21:45 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 10 Aug 2022 19:29:39 +0000 (19:29 +0000)
lightning/src/ln/peer_handler.rs

index 6c9a608b624861d88fbb3b4e3aab165e40ddc182..165d607f199c9dd58fcfbb41557950575335fc75 100644 (file)
@@ -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 {