Merge pull request #1082 from vss96/process_events_docs

Update docs to specify where PeerManager::process_events is called
This commit is contained in:
Matt Corallo 2021-09-21 18:54:19 +00:00 committed by GitHub
commit 4419191840
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1169,6 +1169,9 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
/// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
/// issues! /// 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.
///
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
/// [`send_data`]: SocketDescriptor::send_data /// [`send_data`]: SocketDescriptor::send_data