1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
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`].
15 * Locks are taken internally, so you must never assume that reentrancy from a
16 * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
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.
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.
30 * [`read_event`]: PeerManager::read_event
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 {
38 if (ptr != 0) { bindings.PeerManager_free(ptr); }
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.
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 org.ldk.structs.PeerManager ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.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);
65 * Get the list of node ids for peers which have completed the initial handshake.
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.
71 public byte[][] get_peer_node_ids() {
72 byte[][] ret = bindings.PeerManager_get_peer_node_ids(this.ptr);
73 Reference.reachabilityFence(this);
78 * Indicates a new outbound connection has been established to a node with the given node_id
79 * and an optional remote network address.
81 * The remote network address adds the option to report a remote IP address back to a connecting
82 * peer using the init message.
83 * The user should pass the remote network address of the host they are connected to.
85 * If an `Err` is returned here you must disconnect the connection immediately.
87 * Returns a small number of bytes to send to the remote node (currently always 50).
89 * Panics if descriptor is duplicative with some other descriptor which has not yet been
90 * [`socket_disconnected()`].
92 * [`socket_disconnected()`]: PeerManager::socket_disconnected
94 public Result_CVec_u8ZPeerHandleErrorZ new_outbound_connection(byte[] their_node_id, SocketDescriptor descriptor, Option_NetAddressZ remote_network_address) {
95 long ret = bindings.PeerManager_new_outbound_connection(this.ptr, InternalUtils.check_arr_len(their_node_id, 33), descriptor == null ? 0 : descriptor.ptr, remote_network_address.ptr);
96 Reference.reachabilityFence(this);
97 Reference.reachabilityFence(their_node_id);
98 Reference.reachabilityFence(descriptor);
99 Reference.reachabilityFence(remote_network_address);
100 if (ret >= 0 && ret <= 4096) { return null; }
101 Result_CVec_u8ZPeerHandleErrorZ ret_hu_conv = Result_CVec_u8ZPeerHandleErrorZ.constr_from_ptr(ret);
102 this.ptrs_to.add(descriptor);
107 * Indicates a new inbound connection has been established to a node with an optional remote
110 * The remote network address adds the option to report a remote IP address back to a connecting
111 * peer using the init message.
112 * The user should pass the remote network address of the host they are connected to.
114 * May refuse the connection by returning an Err, but will never write bytes to the remote end
115 * (outbound connector always speaks first). If an `Err` is returned here you must disconnect
116 * the connection immediately.
118 * Panics if descriptor is duplicative with some other descriptor which has not yet been
119 * [`socket_disconnected()`].
121 * [`socket_disconnected()`]: PeerManager::socket_disconnected
123 public Result_NonePeerHandleErrorZ new_inbound_connection(SocketDescriptor descriptor, Option_NetAddressZ remote_network_address) {
124 long ret = bindings.PeerManager_new_inbound_connection(this.ptr, descriptor == null ? 0 : descriptor.ptr, remote_network_address.ptr);
125 Reference.reachabilityFence(this);
126 Reference.reachabilityFence(descriptor);
127 Reference.reachabilityFence(remote_network_address);
128 if (ret >= 0 && ret <= 4096) { return null; }
129 Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
130 this.ptrs_to.add(descriptor);
135 * Indicates that there is room to write data to the given socket descriptor.
137 * May return an Err to indicate that the connection should be closed.
139 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
140 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
141 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
142 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
145 * [`send_data`]: SocketDescriptor::send_data
146 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
148 public Result_NonePeerHandleErrorZ write_buffer_space_avail(SocketDescriptor descriptor) {
149 long ret = bindings.PeerManager_write_buffer_space_avail(this.ptr, descriptor == null ? 0 : descriptor.ptr);
150 Reference.reachabilityFence(this);
151 Reference.reachabilityFence(descriptor);
152 if (ret >= 0 && ret <= 4096) { return null; }
153 Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
158 * Indicates that data was read from the given socket descriptor.
160 * May return an Err to indicate that the connection should be closed.
162 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
163 * Thus, however, you should call [`process_events`] after any `read_event` to generate
164 * [`send_data`] calls to handle responses.
166 * If `Ok(true)` is returned, further read_events should not be triggered until a
167 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
170 * [`send_data`]: SocketDescriptor::send_data
171 * [`process_events`]: PeerManager::process_events
173 public Result_boolPeerHandleErrorZ read_event(SocketDescriptor peer_descriptor, byte[] data) {
174 long ret = bindings.PeerManager_read_event(this.ptr, peer_descriptor == null ? 0 : peer_descriptor.ptr, data);
175 Reference.reachabilityFence(this);
176 Reference.reachabilityFence(peer_descriptor);
177 Reference.reachabilityFence(data);
178 if (ret >= 0 && ret <= 4096) { return null; }
179 Result_boolPeerHandleErrorZ ret_hu_conv = Result_boolPeerHandleErrorZ.constr_from_ptr(ret);
184 * Checks for any events generated by our handlers and processes them. Includes sending most
185 * response messages as well as messages generated by calls to handler functions directly (eg
186 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
188 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
191 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
192 * or one of the other clients provided in our language bindings.
194 * Note that if there are any other calls to this function waiting on lock(s) this may return
195 * without doing any work. All available events that need handling will be handled before the
196 * other calls return.
198 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
199 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
200 * [`send_data`]: SocketDescriptor::send_data
202 public void process_events() {
203 bindings.PeerManager_process_events(this.ptr);
204 Reference.reachabilityFence(this);
208 * Indicates that the given socket descriptor's connection is now closed.
210 public void socket_disconnected(SocketDescriptor descriptor) {
211 bindings.PeerManager_socket_disconnected(this.ptr, descriptor == null ? 0 : descriptor.ptr);
212 Reference.reachabilityFence(this);
213 Reference.reachabilityFence(descriptor);
217 * Disconnect a peer given its node id.
219 * Set `no_connection_possible` to true to prevent any further connection with this peer,
220 * force-closing any channels we have with it.
222 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
223 * peer. Thus, be very careful about reentrancy issues.
225 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
227 public void disconnect_by_node_id(byte[] node_id, boolean no_connection_possible) {
228 bindings.PeerManager_disconnect_by_node_id(this.ptr, InternalUtils.check_arr_len(node_id, 33), no_connection_possible);
229 Reference.reachabilityFence(this);
230 Reference.reachabilityFence(node_id);
231 Reference.reachabilityFence(no_connection_possible);
235 * Disconnects all currently-connected peers. This is useful on platforms where there may be
236 * an indication that TCP sockets have stalled even if we weren't around to time them out
237 * using regular ping/pongs.
239 public void disconnect_all_peers() {
240 bindings.PeerManager_disconnect_all_peers(this.ptr);
241 Reference.reachabilityFence(this);
245 * Send pings to each peer and disconnect those which did not respond to the last round of
248 * This may be called on any timescale you want, however, roughly once every ten seconds is
249 * preferred. The call rate determines both how often we send a ping to our peers and how much
250 * time they have to respond before we disconnect them.
252 * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
255 * [`send_data`]: SocketDescriptor::send_data
257 public void timer_tick_occurred() {
258 bindings.PeerManager_timer_tick_occurred(this.ptr);
259 Reference.reachabilityFence(this);