Struct PeerSetGuard 

pub struct PeerSetGuard {
    background_tasks_sender: Option<Sender<Vec<JoinHandle<Result<(), BoxError>>>>>,
    demand_receiver: Option<Receiver<MorePeers>>,
    inventory_sender: Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>,
    address_book: Option<Arc<Mutex<AddressBook>>>,
}

A helper type to keep track of some dummy endpoints sent to a test PeerSet instance.

Fields

background_tasks_sender: Option<Sender<Vec<JoinHandle<Result<(), BoxError>>>>>

demand_receiver: Option<Receiver<MorePeers>>

inventory_sender: Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>

address_book: Option<Arc<Mutex<AddressBook>>>

Implementations

impl PeerSetGuard

pub fn new() -> Self

Create a new empty PeerSetGuard instance.

pub fn background_tasks_sender( &mut self, ) -> &mut Option<Sender<Vec<JoinHandle<Result<(), BoxError>>>>>

Return a mutable reference to the background tasks sender, if present.

pub fn demand_receiver(&mut self) -> &mut Option<Receiver<MorePeers>>

Return a mutable reference to the background tasks sender, if present.

pub fn inventory_sender( &mut self, ) -> &mut Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>

Return a mutable reference to the background tasks sender, if present.

pub fn address_book(&mut self) -> &mut Option<Arc<Mutex<AddressBook>>>

Return a mutable reference to the background tasks sender, if present.

pub fn create_background_tasks_receiver( &mut self, ) -> Receiver<Vec<JoinHandle<Result<(), BoxError>>>>

Create a dummy channel for the background tasks sent to the PeerSet.

The sender is stored inside the PeerSetGuard, while the receiver is returned to be passed to the PeerSet constructor.

pub fn create_demand_sender(&mut self) -> Sender<MorePeers>

Create a dummy channel for the PeerSet to send demand signals for more peers.

The receiver is stored inside the PeerSetGuard, while the sender is returned to be passed to the PeerSet constructor.

pub fn create_inventory_receiver( &mut self, ) -> Receiver<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>

Create a dummy channel for the inventory hashes sent to the PeerSet.

The sender is stored inside the PeerSetGuard, while the receiver is returned to be passed to the PeerSet constructor.

pub fn prepare_address_book( &mut self, maybe_address_book: Option<Arc<Mutex<AddressBook>>>, ) -> Receiver<AddressMetrics>

Prepare an AddressBook instance to send to the PeerSet.

If the maybe_address_book parameter contains an AddressBook instance, it is stored inside the PeerSetGuard to keep track of it. Otherwise, a new instance is created with the Self::fallback_address_book method.

Returns a metrics watch channel for the AddressBook instance tracked by the PeerSetGuard, so it can be passed to the PeerSet constructor.

fn fallback_address_book() -> Arc<Mutex<AddressBook>>

Create an empty AddressBook instance using a dummy local listener address.

Trait Implementations

impl Default for PeerSetGuard

fn default() -> PeerSetGuard

Returns the “default value” for a type.

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: 48 bytes