Struct exonum::blockchain::ApiSender

pub struct ApiSender<T = Verified<AnyTx>>(_);

Asynchronous sender of messages (transactions by default). The receiver of messages is usually an Exonum node, which then processes them with the consensus algorithm.

Methods

impl<T: Send + 'static> ApiSender<T>

pub fn new(inner: Sender<T>) -> Self

Creates new ApiSender with the given channel.

pub fn closed() -> Self

Creates a dummy sender which is not connected to anything and thus cannot send messages.

pub async fn send_message<'_>(&'_ mut self, message: T) -> Result<(), SendError>

Sends a message to the node asynchronously.

Return value

The failure means that the node is being shut down.

pub fn send_message_blocking(&self, message: T) -> Result<(), SendError>

Sends a message to the node synchronously.

Return value

The failure means that the node is being shut down.

impl ApiSender

pub fn broadcast_transaction(
    &self,
    tx: Verified<AnyTx>
) -> impl Future<Output = Result<(), SendError>>

Sends a transaction over the channel. If this sender is connected to a node, this will broadcast the transaction to all nodes in the blockchain network.

Return value

The failure means that the node is being shut down.

pub fn broadcast_transaction_blocking(
    &self,
    tx: Verified<AnyTx>
) -> Result<(), SendError>

Sends a transaction over the channel synchronously. If this sender is connected to a node, this will broadcast the transaction to all nodes in the blockchain network.

This is an blocking operation that can take some time if the node is overloaded with requests.

Return value

The failure means that the node is being shut down.

Trait Implementations

impl<T> Clone for ApiSender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ApiSender<T>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.