Split Event, move MessageSendEvent push() inside channel_state lock

[rust-lightning] / src / util / events.rs

diff --git a/src/util/events.rs b/src/util/events.rs
index 3a077a4b5ba9caad01086b23bad35a404217a57f..261ee57ccc08fca9ca413416d6317ad5d150f9fc 100644 (file)
--- a/src/util/events.rs
+++ b/src/util/events.rs
@@ -24,7 +24,6 @@ use std::time::Instant;
 
 /// An Event which you should probably take some action in response to.
 pub enum Event {
-       // Events a user will probably have to handle
        /// Used to indicate that the client should generate a funding transaction with the given
        /// parameters and then call ChannelManager::funding_transaction_generated.
        /// Generated in ChannelManager message handling.
@@ -97,13 +96,14 @@ pub enum Event {
                /// The outputs which you should store as spendable by you.
                outputs: Vec<SpendableOutputDescriptor>,
        },
+}
 
-       // Events indicating the network loop should send a message to a peer:
-       // TODO: Move these into a separate struct and make a top-level enum
+/// An event generated by ChannelManager which indicates a message should be sent to a peer (or
+/// broadcast to most peers).
+/// These events are handled by PeerManager::process_events if you are using a PeerManager.
+pub enum MessageSendEvent {
        /// Used to indicate that we've initialted a channel open and should send the open_channel
        /// message provided to the given peer.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        SendOpenChannel {
                /// The node_id of the node which should receive this message
                node_id: PublicKey,
@@ -111,8 +111,6 @@ pub enum Event {
                msg: msgs::OpenChannel,
        },
        /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        SendFundingCreated {
                /// The node_id of the node which should receive this message
                node_id: PublicKey,
@@ -120,8 +118,6 @@ pub enum Event {
                msg: msgs::FundingCreated,
        },
        /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        SendFundingLocked {
                /// The node_id of the node which should receive these message(s)
                node_id: PublicKey,
@@ -132,8 +128,6 @@ pub enum Event {
        },
        /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
        /// message should be sent to the peer with the given node_id.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        UpdateHTLCs {
                /// The node_id of the node which should receive these message(s)
                node_id: PublicKey,
@@ -141,8 +135,6 @@ pub enum Event {
                updates: msgs::CommitmentUpdate,
        },
        /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        SendRevokeAndACK {
                /// The node_id of the node which should receive this message
                node_id: PublicKey,
@@ -150,8 +142,6 @@ pub enum Event {
                msg: msgs::RevokeAndACK,
        },
        /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        SendShutdown {
                /// The node_id of the node which should receive this message
                node_id: PublicKey,
@@ -160,8 +150,6 @@ pub enum Event {
        },
        /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
        /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        BroadcastChannelAnnouncement {
                /// The channel_announcement which should be sent.
                msg: msgs::ChannelAnnouncement,
@@ -169,17 +157,11 @@ pub enum Event {
                update_msg: msgs::ChannelUpdate,
        },
        /// Used to indicate that a channel_update should be broadcast to all peers.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        BroadcastChannelUpdate {
                /// The channel_update which should be sent.
                msg: msgs::ChannelUpdate,
        },
-
-       //Error handling
        /// Broadcast an error downstream to be handled
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        HandleError {
                /// The node_id of the node which should receive this message
                node_id: PublicKey,
@@ -188,14 +170,19 @@ pub enum Event {
        },
        /// When a payment fails we may receive updates back from the hop where it failed. In such
        /// cases this event is generated so that we can inform the router of this information.
-       ///
-       /// This event is handled by PeerManager::process_events if you are using a PeerManager.
        PaymentFailureNetworkUpdate {
                /// The channel/node update which should be sent to router
                update: msgs::HTLCFailChannelUpdate,
        }
 }
 
+/// A trait indicating an object may generate message send events
+pub trait MessageSendEventsProvider {
+       /// Gets the list of pending events which were generated by previous actions, clearing the list
+       /// in the process.
+       fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
+}
+
 /// A trait indicating an object may generate events
 pub trait EventsProvider {
        /// Gets the list of pending events which were generated by previous actions, clearing the list