]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Update docs to specify where process events is called
authorvss96 <shettyvikas209@gmail.com>
Mon, 20 Sep 2021 19:05:26 +0000 (00:35 +0530)
committerMatt Corallo <git@bluematt.me>
Tue, 21 Sep 2021 17:13:22 +0000 (17:13 +0000)
lightning/src/ln/peer_handler.rs

index c9bc40c945aa5df7263aec01667a55d17eddad0d..80edebc69b428bc5c16db95899005c5dac1f9e05 100644 (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
        /// 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
        /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
        /// [`send_data`]: SocketDescriptor::send_data