Skip to content

Commit 94e818b

Browse files
committed
Update docs to specify where process events is called
1 parent 801d6e5 commit 94e818b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lightning/src/ln/peer_handler.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1165,10 +1165,13 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
11651165
/// Checks for any events generated by our handlers and processes them. Includes sending most
11661166
/// response messages as well as messages generated by calls to handler functions directly (eg
11671167
/// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1168-
///
1168+
///
11691169
/// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
11701170
/// issues!
11711171
///
1172+
/// You don't have to call this function explicitly if you are using lightning-net-tokio
1173+
/// or one of the other clients provided in our language bindings.
1174+
///
11721175
/// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
11731176
/// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
11741177
/// [`send_data`]: SocketDescriptor::send_data

0 commit comments

Comments
 (0)