Commit latest auto-generated C bindings based on 0.0.100
[ldk-c-bindings] / lightning-c-bindings / src / lightning / ln / peer_handler.rs
index cad056099405deca31539f1f0c5f87885553eb26..c0a61bc6e9c050ff317ec531cdcd0d25e329ba0d 100644 (file)
@@ -881,9 +881,12 @@ pub extern "C" fn PeerManager_disconnect_by_node_id(this_arg: &PeerManager, mut
        unsafe { &*this_arg.inner }.disconnect_by_node_id(node_id.into_rust(), no_connection_possible)
 }
 
-/// This function should be called roughly once every 30 seconds.
-/// It will send pings to each peer and disconnect those which did not respond to the last
-/// round of pings.
+/// Send pings to each peer and disconnect those which did not respond to the last round of
+/// pings.
+///
+/// This may be called on any timescale you want, however, roughly once every five to ten
+/// seconds is preferred. The call rate determines both how often we send a ping to our peers
+/// and how much time they have to respond before we disconnect them.
 ///
 /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
 /// issues!