Enum MessageSendInstructions

pub enum MessageSendInstructions {
    WithSpecifiedReplyPath {
        destination: Destination,
        reply_path: BlindedMessagePath,
    },
    WithReplyPath {
        destination: Destination,
        context: MessageContext,
    },
    WithoutReplyPath {
        destination: Destination,
    },
    ForReply {
        instructions: ResponseInstruction,
    },
    ForwardedMessage {
        destination: Destination,
        reply_path: Option<BlindedMessagePath>,
    },
}

Instructions for how and where to send a message.

Variants

WithSpecifiedReplyPath

Indicates that a message should be sent including the provided reply path for the recipient to respond.

Fields

destination: Destination

The destination where we need to send our message.

reply_path: BlindedMessagePath

The reply path which should be included in the message.

WithReplyPath

Indicates that a message should be sent including a reply path for the recipient to respond.

Fields

destination: Destination

The destination where we need to send our message.

context: MessageContext

The context to include in the reply path we’ll give the recipient so they can respond to us.

WithoutReplyPath

Indicates that a message should be sent without including a reply path, preventing the recipient from responding.

Fields

destination: Destination

The destination where we need to send our message.

ForReply

Indicates that a message is being sent as a reply to a received message.

Fields

instructions: ResponseInstruction

The instructions provided by the Responder.

ForwardedMessage

Indicates that this onion message did not originate from our node and is being forwarded through us from another node on the network to the destination.

We separate out this case because forwarded onion messages are treated differently from outbound onion messages initiated by our node. Outbounds are buffered internally, whereas, for DoS protection, forwards should never be buffered internally and instead will either be dropped or generate an Event::OnionMessageIntercepted if the next-hop node is disconnected.

Fields

destination: Destination

The destination where we need to send the forwarded onion message.

reply_path: Option<BlindedMessagePath>

The reply path which should be included in the message, that terminates at the original sender of this forwarded message.

Trait Implementations

impl Clone for MessageSendInstructions

fn clone(&self) -> MessageSendInstructions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.