X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FPeerManager.java;h=e41024f8ed7b6397687d8a0748103959b8a56cee;hb=ff3dacec3be60f870d81f6df11bd9fff92aa6047;hp=2bb4ba9b395114d3e96c3d1414aa0f4b02ddf938;hpb=aa0e2aade37133339f4113a0cd7465b111f0a0d0;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/PeerManager.java b/src/main/java/org/ldk/structs/PeerManager.java
index 2bb4ba9b..e41024f8 100644
--- a/src/main/java/org/ldk/structs/PeerManager.java
+++ b/src/main/java/org/ldk/structs/PeerManager.java
@@ -4,7 +4,31 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
 
+
+/**
+ * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
+ * socket events into messages which it passes on to its [`MessageHandler`].
+ * 
+ * Locks are taken internally, so you must never assume that reentrancy from a
+ * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
+ * 
+ * Calls to [`read_event`] will decode relevant messages and pass them to the
+ * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
+ * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
+ * [`PeerManager`] functions related to the same connection must occur only in serial, making new
+ * calls only after previous ones have returned.
+ * 
+ * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
+ * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
+ * essentially you should default to using a SimpleRefPeerManager, and use a
+ * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
+ * you're using lightning-net-tokio.
+ * 
+ * [`read_event`]: PeerManager::read_event
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class PeerManager extends CommonBase {
 	PeerManager(Object _dummy, long ptr) { super(ptr); }
@@ -14,63 +38,223 @@ public class PeerManager extends CommonBase {
 		if (ptr != 0) { bindings.PeerManager_free(ptr); }
 	}
 
-	public static PeerManager constructor_new(ChannelMessageHandler message_handler_chan_handler_arg, RoutingMessageHandler message_handler_route_handler_arg, byte[] our_node_secret, byte[] ephemeral_random_data, Logger logger) {
-		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);
-		PeerManager ret_hu_conv = new PeerManager(null, ret);
+	/**
+	 * Constructs a new PeerManager with the given message handlers and node_id secret key
+	 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
+	 * cryptographically secure random bytes.
+	 */
+	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) {
+		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);
+		Reference.reachabilityFence(message_handler_chan_handler_arg);
+		Reference.reachabilityFence(message_handler_route_handler_arg);
+		Reference.reachabilityFence(our_node_secret);
+		Reference.reachabilityFence(ephemeral_random_data);
+		Reference.reachabilityFence(logger);
+		Reference.reachabilityFence(custom_message_handler);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		PeerManager ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PeerManager(null, ret); }
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		ret_hu_conv.ptrs_to.add(message_handler_chan_handler_arg);
 		ret_hu_conv.ptrs_to.add(message_handler_route_handler_arg);
 		ret_hu_conv.ptrs_to.add(logger);
+		ret_hu_conv.ptrs_to.add(custom_message_handler);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Get the list of node ids for peers which have completed the initial handshake.
+	 * 
+	 * For outbound connections, this will be the same as the their_node_id parameter passed in to
+	 * new_outbound_connection, however entries will only appear once the initial handshake has
+	 * completed and we are sure the remote peer has the private key for the given node_id.
+	 */
 	public byte[][] get_peer_node_ids() {
 		byte[][] ret = bindings.PeerManager_get_peer_node_ids(this.ptr);
+		Reference.reachabilityFence(this);
 		return ret;
 	}
 
-	public Result_CVec_u8ZPeerHandleErrorZ new_outbound_connection(byte[] their_node_id, SocketDescriptor descriptor) {
-		long ret = bindings.PeerManager_new_outbound_connection(this.ptr, their_node_id, descriptor == null ? 0 : descriptor.ptr);
+	/**
+	 * Indicates a new outbound connection has been established to a node with the given node_id
+	 * and an optional remote network address.
+	 * 
+	 * The remote network address adds the option to report a remote IP address back to a connecting
+	 * peer using the init message.
+	 * The user should pass the remote network address of the host they are connected to.
+	 * 
+	 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
+	 * descriptor but must disconnect the connection immediately.
+	 * 
+	 * Returns a small number of bytes to send to the remote node (currently always 50).
+	 * 
+	 * Panics if descriptor is duplicative with some other descriptor which has not yet been
+	 * [`socket_disconnected()`].
+	 * 
+	 * [`socket_disconnected()`]: PeerManager::socket_disconnected
+	 */
+	public Result_CVec_u8ZPeerHandleErrorZ new_outbound_connection(byte[] their_node_id, SocketDescriptor descriptor, Option_NetAddressZ remote_network_address) {
+		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);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(their_node_id);
+		Reference.reachabilityFence(descriptor);
+		Reference.reachabilityFence(remote_network_address);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_CVec_u8ZPeerHandleErrorZ ret_hu_conv = Result_CVec_u8ZPeerHandleErrorZ.constr_from_ptr(ret);
-		ret_hu_conv.ptrs_to.add(this);
 		this.ptrs_to.add(descriptor);
 		return ret_hu_conv;
 	}
 
-	public Result_NonePeerHandleErrorZ new_inbound_connection(SocketDescriptor descriptor) {
-		long ret = bindings.PeerManager_new_inbound_connection(this.ptr, descriptor == null ? 0 : descriptor.ptr);
+	/**
+	 * Indicates a new inbound connection has been established to a node with an optional remote
+	 * network address.
+	 * 
+	 * The remote network address adds the option to report a remote IP address back to a connecting
+	 * peer using the init message.
+	 * The user should pass the remote network address of the host they are connected to.
+	 * 
+	 * May refuse the connection by returning an Err, but will never write bytes to the remote end
+	 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
+	 * call socket_disconnected for the new descriptor but must disconnect the connection
+	 * immediately.
+	 * 
+	 * Panics if descriptor is duplicative with some other descriptor which has not yet been
+	 * [`socket_disconnected()`].
+	 * 
+	 * [`socket_disconnected()`]: PeerManager::socket_disconnected
+	 */
+	public Result_NonePeerHandleErrorZ new_inbound_connection(SocketDescriptor descriptor, Option_NetAddressZ remote_network_address) {
+		long ret = bindings.PeerManager_new_inbound_connection(this.ptr, descriptor == null ? 0 : descriptor.ptr, remote_network_address.ptr);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(descriptor);
+		Reference.reachabilityFence(remote_network_address);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
-		ret_hu_conv.ptrs_to.add(this);
 		this.ptrs_to.add(descriptor);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Indicates that there is room to write data to the given socket descriptor.
+	 * 
+	 * May return an Err to indicate that the connection should be closed.
+	 * 
+	 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
+	 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
+	 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
+	 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
+	 * sufficient!
+	 * 
+	 * [`send_data`]: SocketDescriptor::send_data
+	 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
+	 */
 	public Result_NonePeerHandleErrorZ write_buffer_space_avail(SocketDescriptor descriptor) {
 		long ret = bindings.PeerManager_write_buffer_space_avail(this.ptr, descriptor == null ? 0 : descriptor.ptr);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(descriptor);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_NonePeerHandleErrorZ ret_hu_conv = Result_NonePeerHandleErrorZ.constr_from_ptr(ret);
-		ret_hu_conv.ptrs_to.add(this);
-		this.ptrs_to.add(descriptor);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Indicates that data was read from the given socket descriptor.
+	 * 
+	 * May return an Err to indicate that the connection should be closed.
+	 * 
+	 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
+	 * Thus, however, you should call [`process_events`] after any `read_event` to generate
+	 * [`send_data`] calls to handle responses.
+	 * 
+	 * If `Ok(true)` is returned, further read_events should not be triggered until a
+	 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
+	 * send buffer).
+	 * 
+	 * [`send_data`]: SocketDescriptor::send_data
+	 * [`process_events`]: PeerManager::process_events
+	 */
 	public Result_boolPeerHandleErrorZ read_event(SocketDescriptor peer_descriptor, byte[] data) {
 		long ret = bindings.PeerManager_read_event(this.ptr, peer_descriptor == null ? 0 : peer_descriptor.ptr, data);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(peer_descriptor);
+		Reference.reachabilityFence(data);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_boolPeerHandleErrorZ ret_hu_conv = Result_boolPeerHandleErrorZ.constr_from_ptr(ret);
-		ret_hu_conv.ptrs_to.add(this);
-		this.ptrs_to.add(peer_descriptor);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Checks for any events generated by our handlers and processes them. Includes sending most
+	 * response messages as well as messages generated by calls to handler functions directly (eg
+	 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
+	 * 
+	 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
+	 * issues!
+	 * 
+	 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
+	 * or one of the other clients provided in our language bindings.
+	 * 
+	 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
+	 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
+	 * [`send_data`]: SocketDescriptor::send_data
+	 */
 	public void process_events() {
 		bindings.PeerManager_process_events(this.ptr);
+		Reference.reachabilityFence(this);
 	}
 
+	/**
+	 * Indicates that the given socket descriptor's connection is now closed.
+	 */
 	public void socket_disconnected(SocketDescriptor descriptor) {
 		bindings.PeerManager_socket_disconnected(this.ptr, descriptor == null ? 0 : descriptor.ptr);
-		this.ptrs_to.add(descriptor);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(descriptor);
+	}
+
+	/**
+	 * Disconnect a peer given its node id.
+	 * 
+	 * Set `no_connection_possible` to true to prevent any further connection with this peer,
+	 * force-closing any channels we have with it.
+	 * 
+	 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
+	 * peer. Thus, be very careful about reentrancy issues.
+	 * 
+	 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
+	 */
+	public void disconnect_by_node_id(byte[] node_id, boolean no_connection_possible) {
+		bindings.PeerManager_disconnect_by_node_id(this.ptr, InternalUtils.check_arr_len(node_id, 33), no_connection_possible);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(node_id);
+		Reference.reachabilityFence(no_connection_possible);
+	}
+
+	/**
+	 * Disconnects all currently-connected peers. This is useful on platforms where there may be
+	 * an indication that TCP sockets have stalled even if we weren't around to time them out
+	 * using regular ping/pongs.
+	 */
+	public void disconnect_all_peers() {
+		bindings.PeerManager_disconnect_all_peers(this.ptr);
+		Reference.reachabilityFence(this);
 	}
 
-	public void timer_tick_occured() {
-		bindings.PeerManager_timer_tick_occured(this.ptr);
+	/**
+	 * 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 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!
+	 * 
+	 * [`send_data`]: SocketDescriptor::send_data
+	 */
+	public void timer_tick_occurred() {
+		bindings.PeerManager_timer_tick_occurred(this.ptr);
+		Reference.reachabilityFence(this);
 	}
 
 }