_ Git - ldk-java/blob - src/main/java/org/ldk/structs/PeerManager.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
  13  * socket events into messages which it passes on to its [`MessageHandler`].
  14  *
  15  * Locks are taken internally, so you must never assume that reentrancy from a
  16  * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
  17  *
  18  * Calls to [`read_event`] will decode relevant messages and pass them to the
  19  * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
  20  * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
  21  * [`PeerManager`] functions related to the same connection must occur only in serial, making new
  22  * calls only after previous ones have returned.
  23  *
  24  * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
  25  * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
  26  * essentially you should default to using a SimpleRefPeerManager, and use a
  27  * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
  28  * you're using lightning-net-tokio.
  29  *
  30  * [`read_event`]: PeerManager::read_event
  31  */
  32 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  33 public class PeerManager extends CommonBase {
  34         PeerManager(Object _dummy, long ptr) { super(ptr); }
  35         @Override @SuppressWarnings("deprecation")
  36         protected void finalize() throws Throwable {
  37                 super.finalize();
  38                 if (ptr != 0) { bindings.PeerManager_free(ptr); }
  39         }
  40
  41         /**
  42          * Constructs a new PeerManager with the given message handlers and node_id secret key
  43          * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
  44          * cryptographically secure random bytes.
  45          */
  46         public static PeerManager of(ChannelMessageHandler message_handler_chan_handler_arg, RoutingMessageHandler message_handler_route_handler_arg, byte[] our_node_secret, byte[] ephemeral_random_data, Logger logger, CustomMessageHandler custom_message_handler) {
  47                 long ret = bindings.PeerManager_new(bindings.MessageHandler_new(message_handler_chan_handler_arg == null ? 0 : message_handler_chan_handler_arg.ptr, message_handler_route_handler_arg == null ? 0 : message_handler_route_handler_arg.ptr), InternalUtils.check_arr_len(our_node_secret, 32), InternalUtils.check_arr_len(ephemeral_random_data, 32), logger == null ? 0 : logger.ptr, custom_message_handler == null ? 0 : custom_message_handler.ptr);
  48                 Reference.reachabilityFence(message_handler_chan_handler_arg);
  49                 Reference.reachabilityFence(message_handler_route_handler_arg);
  50                 Reference.reachabilityFence(our_node_secret);
  51                 Reference.reachabilityFence(ephemeral_random_data);
  52                 Reference.reachabilityFence(logger);
  53                 Reference.reachabilityFence(custom_message_handler);
  54                 if (ret >= 0 && ret <= 4096) { return null; }
  55                 PeerManager ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PeerManager(null, ret); }
  56                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  57                 ret_hu_conv.ptrs_to.add(message_handler_chan_handler_arg);
  58                 ret_hu_conv.ptrs_to.add(message_handler_route_handler_arg);
  59                 ret_hu_conv.ptrs_to.add(logger);
  60                 ret_hu_conv.ptrs_to.add(custom_message_handler);
  61                 return ret_hu_conv;
  62         }
  63
  64         /**
  65          * Get the list of node ids for peers which have completed the initial handshake.
  66          *
  67          * For outbound connections, this will be the same as the their_node_id parameter passed in to
  68          * new_outbound_connection, however entries will only appear once the initial handshake has
  69          * completed and we are sure the remote peer has the private key for the given node_id.
  70          */
  71         public byte[][] get_peer_node_ids() {
  72                 byte[][] ret = bindings.PeerManager_get_peer_node_ids(this.ptr);
  73                 Reference.reachabilityFence(this);
  74                 return ret;
  75         }
  76
  77         /**
  78          * Indicates a new outbound connection has been established to a node with the given node_id.
  79          * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
  80          * descriptor but must disconnect the connection immediately.
  81          *
  82          * Returns a small number of bytes to send to the remote node (currently always 50).
  83          *
  84          * Panics if descriptor is duplicative with some other descriptor which has not yet been
  85          * [`socket_disconnected()`].
  86          *
  87          * [`socket_disconnected()`]: PeerManager::socket_disconnected
  88          */
  89         public Result_CVec_u8ZPeerHandleErrorZ new_outbound_connection(byte[] their_node_id, SocketDescriptor descriptor) {
  90                 long ret = bindings.PeerManager_new_outbound_connection(this.ptr, InternalUtils.check_arr_len(their_node_id, 33), descriptor == null ? 0 : descriptor.ptr);
  91                 Reference.reachabilityFence(this);
  92                 Reference.reachabilityFence(their_node_id);
  93                 Reference.reachabilityFence(descriptor);
  94                 if (ret >= 0 && ret <= 4096) { return null; }
  95                 Result_CVec_u8ZPeerHandleErrorZ ret_hu_conv = Result_CVec_u8ZPeerHandleErrorZ.constr_from_ptr(ret);
  96                 this.ptrs_to.add(descriptor);
  97                 return ret_hu_conv;
  98         }
  99
 100         /**
 101          * Indicates a new inbound connection has been established.
 102          *
 103          * May refuse the connection by returning an Err, but will never write bytes to the remote end
 104          * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 105          * call socket_disconnected for the new descriptor but must disconnect the connection
 106          * immediately.
 107          *
 108          * Panics if descriptor is duplicative with some other descriptor which has not yet been
 109          * [`socket_disconnected()`].
 110          *
 111          * [`socket_disconnected()`]: PeerManager::socket_disconnected
 112          */
 113         public Result_NonePeerHandleErrorZ new_inbound_connection(SocketDescriptor descriptor) {
 114                 long ret = bindings.PeerManager_new_inbound_connection(this.ptr, descriptor == null ? 0 : descriptor.ptr);
 115                 Reference.reachabilityFence(this);
 116                 Reference.reachabilityFence(descriptor);
 117                 if (ret >= 0 && ret <= 4096) { return null; }
 118                 Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
 119                 this.ptrs_to.add(descriptor);
 120                 return ret_hu_conv;
 121         }
 122
 123         /**
 124          * Indicates that there is room to write data to the given socket descriptor.
 125          *
 126          * May return an Err to indicate that the connection should be closed.
 127          *
 128          * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
 129          * returning. Thus, be very careful with reentrancy issues! The invariants around calling
 130          * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
 131          * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
 132          * sufficient!
 133          *
 134          * [`send_data`]: SocketDescriptor::send_data
 135          * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
 136          */
 137         public Result_NonePeerHandleErrorZ write_buffer_space_avail(SocketDescriptor descriptor) {
 138                 long ret = bindings.PeerManager_write_buffer_space_avail(this.ptr, descriptor == null ? 0 : descriptor.ptr);
 139                 Reference.reachabilityFence(this);
 140                 Reference.reachabilityFence(descriptor);
 141                 if (ret >= 0 && ret <= 4096) { return null; }
 142                 Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
 143                 return ret_hu_conv;
 144         }
 145
 146         /**
 147          * Indicates that data was read from the given socket descriptor.
 148          *
 149          * May return an Err to indicate that the connection should be closed.
 150          *
 151          * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
 152          * Thus, however, you should call [`process_events`] after any `read_event` to generate
 153          * [`send_data`] calls to handle responses.
 154          *
 155          * If `Ok(true)` is returned, further read_events should not be triggered until a
 156          * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
 157          * send buffer).
 158          *
 159          * [`send_data`]: SocketDescriptor::send_data
 160          * [`process_events`]: PeerManager::process_events
 161          */
 162         public Result_boolPeerHandleErrorZ read_event(SocketDescriptor peer_descriptor, byte[] data) {
 163                 long ret = bindings.PeerManager_read_event(this.ptr, peer_descriptor == null ? 0 : peer_descriptor.ptr, data);
 164                 Reference.reachabilityFence(this);
 165                 Reference.reachabilityFence(peer_descriptor);
 166                 Reference.reachabilityFence(data);
 167                 if (ret >= 0 && ret <= 4096) { return null; }
 168                 Result_boolPeerHandleErrorZ ret_hu_conv = Result_boolPeerHandleErrorZ.constr_from_ptr(ret);
 169                 return ret_hu_conv;
 170         }
 171
 172         /**
 173          * Checks for any events generated by our handlers and processes them. Includes sending most
 174          * response messages as well as messages generated by calls to handler functions directly (eg
 175          * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
 176          *
 177          * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
 178          * issues!
 179          *
 180          * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
 181          * or one of the other clients provided in our language bindings.
 182          *
 183          * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 184          * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
 185          * [`send_data`]: SocketDescriptor::send_data
 186          */
 187         public void process_events() {
 188                 bindings.PeerManager_process_events(this.ptr);
 189                 Reference.reachabilityFence(this);
 190         }
 191
 192         /**
 193          * Indicates that the given socket descriptor's connection is now closed.
 194          */
 195         public void socket_disconnected(SocketDescriptor descriptor) {
 196                 bindings.PeerManager_socket_disconnected(this.ptr, descriptor == null ? 0 : descriptor.ptr);
 197                 Reference.reachabilityFence(this);
 198                 Reference.reachabilityFence(descriptor);
 199         }
 200
 201         /**
 202          * Disconnect a peer given its node id.
 203          *
 204          * Set `no_connection_possible` to true to prevent any further connection with this peer,
 205          * force-closing any channels we have with it.
 206          *
 207          * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
 208          * peer. Thus, be very careful about reentrancy issues.
 209          *
 210          * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
 211          */
 212         public void disconnect_by_node_id(byte[] node_id, boolean no_connection_possible) {
 213                 bindings.PeerManager_disconnect_by_node_id(this.ptr, InternalUtils.check_arr_len(node_id, 33), no_connection_possible);
 214                 Reference.reachabilityFence(this);
 215                 Reference.reachabilityFence(node_id);
 216                 Reference.reachabilityFence(no_connection_possible);
 217         }
 218
 219         /**
 220          * Disconnects all currently-connected peers. This is useful on platforms where there may be
 221          * an indication that TCP sockets have stalled even if we weren't around to time them out
 222          * using regular ping/pongs.
 223          */
 224         public void disconnect_all_peers() {
 225                 bindings.PeerManager_disconnect_all_peers(this.ptr);
 226                 Reference.reachabilityFence(this);
 227         }
 228
 229         /**
 230          * Send pings to each peer and disconnect those which did not respond to the last round of
 231          * pings.
 232          *
 233          * This may be called on any timescale you want, however, roughly once every five to ten
 234          * seconds is preferred. The call rate determines both how often we send a ping to our peers
 235          * and how much time they have to respond before we disconnect them.
 236          *
 237          * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
 238          * issues!
 239          *
 240          * [`send_data`]: SocketDescriptor::send_data
 241          */
 242         public void timer_tick_occurred() {
 243                 bindings.PeerManager_timer_tick_occurred(this.ptr);
 244                 Reference.reachabilityFence(this);
 245         }
 246
 247 }