Skip to content

Commit fcc5973

Browse files
authored
Merge pull request lightningdevkit#3395 from mhrheaume/mhr/process_events_docs
Updated docs on `PeerManager::process_events`.
2 parents c35adff + 9d07106 commit fcc5973

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

lightning/src/ln/peer_handler.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2057,8 +2057,11 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
20572057
/// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
20582058
/// issues!
20592059
///
2060-
/// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
2061-
/// or one of the other clients provided in our language bindings.
2060+
/// This should be called any time we may have messages to send. It is automatically called by
2061+
/// [`lightning-net-tokio`] after processing incoming messages, and by
2062+
/// [`lightning-background-processor`] when channel state has changed. Therefore, If you are not
2063+
/// using both [`lightning-net-tokio`] and [`lightning-background-processor`], you may need to call
2064+
/// this function manually to prevent messages from being delayed.
20622065
///
20632066
/// Note that if there are any other calls to this function waiting on lock(s) this may return
20642067
/// without doing any work. All available events that need handling will be handled before the

0 commit comments

Comments
 (0)