Trait OnionMessageHandler

pub trait OnionMessageHandler: BaseMessageHandler {
    // Required methods
    fn handle_onion_message(&self, peer_node_id: PublicKey, msg: &OnionMessage);
    fn next_onion_message_for_peer(
        &self,
        peer_node_id: PublicKey,
    ) -> Option<OnionMessage>;
    fn timer_tick_occurred(&self);
}

A handler for received OnionMessages and for providing generated ones to send.

Required Methods

fn handle_onion_message(&self, peer_node_id: PublicKey, msg: &OnionMessage)

Handle an incoming onion_message message from the given peer.

fn next_onion_message_for_peer( &self, peer_node_id: PublicKey, ) -> Option<OnionMessage>

Returns the next pending onion message for the peer with the given node id.

Note that onion messages can only be provided upstream via this method and not via BaseMessageHandler::get_and_clear_pending_msg_events.

fn timer_tick_occurred(&self)

Performs actions that should happen roughly every ten seconds after startup. Allows handlers to drop any buffered onion messages intended for prospective peerst.

Implementors

impl OnionMessageHandler for IgnoringMessageHandler

impl<ES: Deref, NS: Deref, L: Deref, NL: Deref, MR: Deref, OMH: Deref, APH: Deref, DRH: Deref, CMH: Deref> OnionMessageHandler for OnionMessenger<ES, NS, L, NL, MR, OMH, APH, DRH, CMH>

where ES::Target: EntropySource, NS::Target: NodeSigner, L::Target: Logger, NL::Target: NodeIdLookUp, MR::Target: MessageRouter, OMH::Target: OffersMessageHandler, APH::Target: AsyncPaymentsMessageHandler, DRH::Target: DNSResolverMessageHandler, CMH::Target: CustomOnionMessageHandler,