Struct zebrad::components::inbound::downloads::Downloads

pub struct Downloads<ZN, ZV, ZS>where
    ZN: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZN::Future: Send,
    ZV: Service<Request, Response = Hash, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZV::Future: Send,
    ZS: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZS::Future: Send,{
    full_verify_concurrency_limit: usize,
    network: ZN,
    verifier: ZV,
    state: ZS,
    latest_chain_tip: LatestChainTip,
    pending: FuturesUnordered<JoinHandle<Result<Hash, (Box<dyn Error + Send + Sync + 'static>, Hash)>>>,
    cancel_handles: HashMap<Hash, Sender<()>>,
}

Manages download and verification of blocks gossiped to this peer.

Fields

full_verify_concurrency_limit: usize

The configured full verification concurrency limit, after applying the minimum limit.

network: ZN

A service that forwards requests to connected peers, and returns their responses.

verifier: ZV

A service that verifies downloaded blocks.

state: ZS

A service that manages cached blockchain state.

latest_chain_tip: LatestChainTip

Allows efficient access to the best tip of the blockchain.

pending: FuturesUnordered<JoinHandle<Result<Hash, (Box<dyn Error + Send + Sync + 'static>, Hash)>>>

A list of pending block download and verify tasks.

cancel_handles: HashMap<Hash, Sender<()>>

A list of channels that can be used to cancel pending block download and verify tasks.

Implementations

impl<ZN, ZV, ZS> Downloads<ZN, ZV, ZS>where
    ZN: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZN::Future: Send,
    ZV: Service<Request, Response = Hash, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZV::Future: Send,
    ZS: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZS::Future: Send,

pub fn new(
    full_verify_concurrency_limit: usize,
    network: ZN,
    verifier: ZV,
    state: ZS,
    latest_chain_tip: LatestChainTip
) -> Self

Initialize a new download stream with the provided network, verifier, and state services. The latest_chain_tip must be linked to the provided state service.

The Downloads stream is agnostic to the network policy, so retry and timeout limits should be applied to the network service passed into this constructor.

pub fn download_and_verify(&mut self, hash: Hash) -> DownloadAction

Queue a block for download and verification.

Returns the action taken in response to the queue request.

Trait Implementations

impl<ZN, ZV, ZS> Debug for Downloads<ZN, ZV, ZS>where
    ZN: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static + Debug,
    ZN::Future: Send,
    ZV: Service<Request, Response = Hash, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static + Debug,
    ZV::Future: Send,
    ZS: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static + Debug,
    ZS::Future: Send,

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

Formats the value using the given formatter.

impl<ZN, ZV, ZS> Stream for Downloads<ZN, ZV, ZS>where
    ZN: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZN::Future: Send,
    ZV: Service<Request, Response = Hash, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZV::Future: Send,
    ZS: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZS::Future: Send,

type Item = Result<Hash, Box<dyn Error + Sync + Send + 'static, Global>>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, ZN, ZV, ZS> Unpin for Downloads<ZN, ZV, ZS>where
    ZN: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZN::Future: Send,
    ZV: Service<Request, Response = Hash, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZV::Future: Send,
    ZS: Service<Request, Response = Response, Error = Box<dyn Error + Send + Sync + 'static>> + Send + Clone + 'static,
    ZS::Future: Send,
    __Downloads<'pin, ZN, ZV, ZS>: Unpin,