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