Enum MonitorEvent

pub enum MonitorEvent {
    HTLCEvent(HTLCUpdate),
    HolderForceClosedWithInfo {
        reason: ClosureReason,
        outpoint: OutPoint,
        channel_id: ChannelId,
    },
    HolderForceClosed(OutPoint),
    Completed {
        funding_txo: OutPoint,
        channel_id: ChannelId,
        monitor_update_id: u64,
    },
}

An event to be processed by the ChannelManager.

Variants

HTLCEvent(HTLCUpdate)

A monitor event containing an HTLCUpdate.

HolderForceClosedWithInfo

Indicates we broadcasted the channel’s latest commitment transaction and thus closed the channel. Holds information about the channel and why it was closed.

Fields

reason: ClosureReason

The reason the channel was closed.

outpoint: OutPoint

The funding outpoint of the channel.

channel_id: ChannelId

The channel ID of the channel.

HolderForceClosed(OutPoint)

Indicates we broadcasted the channel’s latest commitment transaction and thus closed the channel.

Completed

Indicates a ChannelMonitor update has completed. See ChannelMonitorUpdateStatus::InProgress for more information on how this is used.

Fields

funding_txo: OutPoint

The funding outpoint of the ChannelMonitor that was updated

channel_id: ChannelId

The channel ID of the channel associated with the ChannelMonitor

monitor_update_id: u64

The Update ID from ChannelMonitorUpdate::update_id which was applied or ChannelMonitor::get_latest_update_id.

Note that this should only be set to a given update’s ID if all previous updates for the same ChannelMonitor have been applied and persisted.

Trait Implementations

impl Clone for MonitorEvent

fn clone(&self) -> MonitorEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeReadable for MonitorEvent

fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>

Reads a Self in from the given Read.

impl PartialEq for MonitorEvent

fn eq(&self, other: &MonitorEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Writeable for MonitorEvent

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for MonitorEvent

impl StructuralPartialEq for MonitorEvent