Struct Handle 

pub struct Handle<AccountId, IvkTag> { /* private fields */ }

Available on crate feature sync-decryptor and (crate features sync-decryptor or sync) only.

A handle to a batch decryption Engine.

Implementations

impl<AccountId, IvkTag> Handle<AccountId, IvkTag>

pub async fn queue_block( &self, block: Block, ) -> Option<Receiver<(Arc<ScanningKeys<AccountId, IvkTag>>, BlockHeader, Vec<BatchResult<IvkTag>>)>>

Requests decryption of a block, waiting until there is space in the queue.

Returns None if the batch decryptor has shut down.

pub fn try_queue_block( &self, block: Block, ) -> Result<Receiver<(Arc<ScanningKeys<AccountId, IvkTag>>, BlockHeader, Vec<BatchResult<IvkTag>>)>, TryQueueError<Block>>

Requests decryption of a block, without waiting for queue space.

On failure the rejected block is returned, so that the caller may retry: see TryQueueError.

pub async fn queue_tx( &self, tx: Transaction, mempool_height: BlockHeight, ) -> Option<Receiver<BatchResult<IvkTag>>>

Requests decryption of a transaction, waiting until there is space in the queue.

Returns None if the batch decryptor has shut down.

pub fn try_queue_tx( &self, tx: Transaction, mempool_height: BlockHeight, ) -> Result<Receiver<BatchResult<IvkTag>>, TryQueueError<Transaction>>

Requests decryption of a transaction, without waiting for queue space.

On failure the rejected tx is returned, so that the caller may retry: see TryQueueError.

pub async fn reload_keys(&self) -> Option<Receiver<()>>

Requests that the engine reload its scanning keys, so that accounts or keys added since the engine started (or since the last reload) are applied to subsequently queued blocks and transactions.

The reload is ordered within the queue: every block or transaction queued before this call is decrypted with the previous keys, and everything queued afterwards with the reloaded keys.

Returns a receiver that completes once the reload has been applied, or None if the batch decryptor has shut down.

Note that the returned receiver resolving to an error (because its sender was dropped) does not distinguish “the engine shut down” from “the reload closure passed to Engine::run returned an error, terminating the engine”; in both cases no further requests will be served.

pub fn is_closed(&self) -> bool

Returns true if the batch decryptor has shut down.

This is the only reliable liveness test for the engine. The queuing methods cannot serve as one: a request that wins its queue slot concurrently with the engine shutting down is still accepted, so Some does not imply the request will ever be served. Such a request is also never dropped while any Handle remains, so its receiver resolves neither to a value nor to an error.

pub async fn closed(&self)

Completes when the batch decryptor has shut down.

Use this to wait on shutdown, or to race it against a queued request’s receiver so that a request stranded by a concurrent shutdown does not wait forever. See Handle::is_closed for why the queuing methods cannot report liveness.

Trait Implementations

impl<AccountId: Clone, IvkTag: Clone> Clone for Handle<AccountId, IvkTag>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.