Struct subcoin_network::NetworkHandle

pub struct NetworkHandle { /* private fields */ }

A handle for interacting with the network processor.

This handle allows sending messages to the network processor and provides a simple way to check if the node is performing a major synchronization.

Implementations

impl NetworkHandle

pub async fn status(&self) -> Option<NetworkStatus>

Provides high-level status information about network.

Returns None if the NetworkProcessor is no longer running.

pub async fn sync_peers(&self) -> Vec<PeerSync>

Returns the currently syncing peers.

pub async fn get_transaction(&self, txid: Txid) -> Option<Transaction>

Retrieves a transaction by its Txid.

pub async fn send_transaction( &self, transaction: Transaction, ) -> SendTransactionResult

Sends a transaction to the network.

pub fn start_block_sync(&self) -> bool

Starts the block sync in chain sync component.

pub fn is_major_syncing(&self) -> Arc<AtomicBool>

Returns a flag indicating whether the node is actively performing a major sync.

Trait Implementations

impl Clone for NetworkHandle

fn clone(&self) -> NetworkHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl NetworkApi for NetworkHandle

fn enabled(&self) -> bool

Whether the network instnace is running.

fn status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<NetworkStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Provides high-level status information about network.

fn sync_peers<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Vec<PeerSync>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the currently syncing peers.

fn get_transaction<'life0, 'async_trait>( &'life0 self, txid: Txid, ) -> Pin<Box<dyn Future<Output = Option<Transaction>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves a transaction by its Txid.

fn send_transaction<'life0, 'async_trait>( &'life0 self, transaction: Transaction, ) -> Pin<Box<dyn Future<Output = SendTransactionResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a transaction to the network.

fn start_block_sync(&self) -> bool

Starts the block sync in chain sync component.

fn is_major_syncing(&self) -> bool

Whether the node is actively performing a major sync.