Struct lightning_net_tokio::Connection

pub struct Connection { /* fields omitted */ }

A connection to a remote peer. Can be constructed either as a remote connection using Connection::setup_outbound o

Methods

impl Connection

pub fn setup_inbound(
    peer_manager: Arc<PeerManager<SocketDescriptor>>,
    event_notify: Sender<()>,
    stream: TcpStream
)

Process incoming messages and feed outgoing messages on the provided socket generated by accepting an incoming connection (by scheduling futures with tokio::spawn).

You should poll the Receive end of event_notify and call get_and_clear_pending_events() on ChannelManager and ChannelMonitor objects.

pub fn setup_outbound(
    peer_manager: Arc<PeerManager<SocketDescriptor>>,
    event_notify: Sender<()>,
    their_node_id: PublicKey,
    stream: TcpStream
)

Process incoming messages and feed outgoing messages on the provided socket generated by making an outbound connection which is expected to be accepted by a peer with the given public key (by scheduling futures with tokio::spawn).

You should poll the Receive end of event_notify and call get_and_clear_pending_events() on ChannelManager and ChannelMonitor objects.

pub fn connect_outbound(
    peer_manager: Arc<PeerManager<SocketDescriptor>>,
    event_notify: Sender<()>,
    their_node_id: PublicKey,
    addr: SocketAddr
)

Process incoming messages and feed outgoing messages on a new connection made to the given socket address which is expected to be accepted by a peer with the given public key (by scheduling futures with tokio::spawn).

You should poll the Receive end of event_notify and call get_and_clear_pending_events() on ChannelManager and ChannelMonitor objects.