Struct InventoryRegistry 

pub struct InventoryRegistry {
    current: IndexMap<InventoryHash, IndexMap<PeerSocketAddr, InventoryResponse<(), ()>>>,
    prev: IndexMap<InventoryHash, IndexMap<PeerSocketAddr, InventoryResponse<(), ()>>>,
    failed_current: IndexMap<InventoryHash, IndexSet<PeerSocketAddr>>,
    failed_prev: IndexMap<InventoryHash, IndexSet<PeerSocketAddr>>,
    inv_stream: Pin<Box<dyn Stream<Item = Result<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>, BroadcastStreamRecvError>> + Send + 'static>>,
    interval: IntervalStream,
}

An Inventory Registry for tracking recent inventory advertisements and missing inventory.

For more details please refer to the RFC.

Fields

current: IndexMap<InventoryHash, IndexMap<PeerSocketAddr, InventoryResponse<(), ()>>>

Map tracking the latest inventory status from the current interval period.

prev: IndexMap<InventoryHash, IndexMap<PeerSocketAddr, InventoryResponse<(), ()>>>

Map tracking inventory statuses from the previous interval period.

failed_current: IndexMap<InventoryHash, IndexSet<PeerSocketAddr>>

Map tracking peers that failed to return inventory in the current interval period.

A failure is a completed peer error or response timeout, not caller cancellation or a notfound response. Missing inventory is tracked separately; failed peers might still have it.

Failures are tracked separately from inventory statuses, so a peer can’t clear its failure by advertising the inventory again.

Security

This map is limited like the status maps, using MAX_INV_PER_MAP and MAX_PEERS_PER_INV. So it uses up to 3 MB for both intervals.

failed_prev: IndexMap<InventoryHash, IndexSet<PeerSocketAddr>>

Map tracking peers that failed to return inventory in the previous interval period.

inv_stream: Pin<Box<dyn Stream<Item = Result<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>, BroadcastStreamRecvError>> + Send + 'static>>

Stream of incoming inventory statuses to register.

interval: IntervalStream

Interval tracking when we should next rotate our maps.

Implementations

impl InventoryRegistry

pub fn new( inv_stream: Receiver<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>, ) -> Self

Returns a new Inventory Registry for inv_stream.

pub fn advertising_peers( &self, hash: InventoryHash, ) -> impl Iterator<Item = &PeerSocketAddr>

Returns an iterator over addrs of peers that have recently advertised hash in their inventory.

pub fn missing_peers( &self, hash: InventoryHash, ) -> impl Iterator<Item = &PeerSocketAddr>

Returns an iterator over addrs of peers that have recently missed hash in their inventory.

pub fn failed_peers( &self, hash: InventoryHash, ) -> impl Iterator<Item = &PeerSocketAddr>

Returns an iterator over addrs of peers that recently failed to return hash.

Can include the same peer twice, if it failed in the current and previous interval.

pub fn register_failed(&mut self, hash: InventoryHash, peer: PeerSocketAddr)

Records that peer failed to return hash.

Failures expire after the registry rotates twice, like inventory statuses.

pub fn clear_peer_failures(&mut self, peer: PeerSocketAddr)

Clears failures from previous connections that used peer’s transient address.

pub fn status_peers( &self, hash: InventoryHash, ) -> impl Iterator<Item = InventoryResponse<&PeerSocketAddr, &PeerSocketAddr>>

Returns an iterator over peer inventory statuses for hash.

Prefers current statuses to previously rotated statuses for the same peer.

pub fn has_current_status( &self, hash: InventoryHash, addr: PeerSocketAddr, ) -> bool

Returns true if there is a current status entry for hash and addr.

pub fn status_hashes( &self, ) -> impl Iterator<Item = (&InventoryHash, &IndexMap<PeerSocketAddr, InventoryResponse<(), ()>>)>

Returns an iterator over peer inventory status hashes.

Yields current statuses first, then previously rotated statuses. This can include multiple statuses for the same hash.

pub fn update(&mut self) -> Update<'_>

Returns a future that waits for new registry updates.

pub fn poll_inventory( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), BoxError>>

Drive periodic inventory tasks.

Rotates the inventory HashMaps on every timer tick. Drains the inv_stream channel and registers all advertised inventory.

Returns an error if the inventory channel is closed.

Otherwise, returns Ok if it performed at least one update or rotation, or Poll::Pending if there was no inventory change. Always registers a wakeup for the next inventory update or rotation, even when it returns Ok.

fn register( &mut self, change: InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>, )

Record the given inventory change for the peer addr.

Missing markers are not updated until the registry rotates, for security reasons.

fn rotate(&mut self)

Replace the prev HashMap with current’s and replace current with an empty HashMap

Trait Implementations

impl Debug for InventoryRegistry

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 336 bytes