Skip to main content

ChainEventBus

Struct ChainEventBus 

Source
pub struct ChainEventBus { /* private fields */ }
Expand description

A broadcast-based event bus for chain state changes.

Multiple subscribers can listen for events without blocking the publisher. The bus is cheap to clone (it shares the underlying channel via Arc).

Implementations§

Source§

impl ChainEventBus

Source

pub fn new() -> Self

Create a new event bus with the default capacity.

Source

pub fn with_capacity(capacity: usize) -> Self

Create a new event bus with a custom capacity.

Source

pub fn subscribe(&self) -> Receiver<ChainEvent>

Subscribe to chain events.

Returns a broadcast::Receiver that will receive all events emitted after this call. If the receiver falls behind, it will get a RecvError::Lagged with the number of missed events.

Source

pub fn emit(&self, event: ChainEvent) -> usize

Emit a chain event to all subscribers.

Returns the number of active subscribers that received the event. Returns 0 if there are no subscribers (this is not an error).

Source

pub fn subscriber_count(&self) -> usize

Get the current number of active subscribers.

Source

pub fn notify_block_connected( &self, hash: BlockHash, height: u32, num_txs: usize, ) -> usize

Convenience: emit a BlockConnected event.

Source

pub fn notify_block_disconnected(&self, hash: BlockHash, height: u32) -> usize

Convenience: emit a BlockDisconnected event.

Source

pub fn notify_tx_added(&self, txid: Txid, vsize: u64, fee: i64) -> usize

Convenience: emit a TransactionAddedToMempool event.

Source

pub fn notify_tx_removed( &self, txid: Txid, reason: MempoolRemovalReason, ) -> usize

Convenience: emit a TransactionRemovedFromMempool event.

Trait Implementations§

Source§

impl Clone for ChainEventBus

Source§

fn clone(&self) -> ChainEventBus

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ChainEventBus

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more