mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-03-15 15:39:09 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3395 from mhrheaume/mhr/process_events_docs

Browse source 
Updated docs on `PeerManager::process_events`.
This commit is contained in:
Matt Corallo 2024-11-07 17:54:03 +00:00 • committed by GitHub
commit fcc59730a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
lightning/src/ln/peer_handler.rs
View file

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