Enum zebra_network::meta_addr::MetaAddrChange

pub enum MetaAddrChange {
    NewInitial {
        addr: PeerSocketAddr,
    },
    NewGossiped {
        addr: PeerSocketAddr,
        untrusted_services: PeerServices,
        untrusted_last_seen: DateTime32,
    },
    NewLocal {
        addr: PeerSocketAddr,
    },
    UpdateAttempt {
        addr: PeerSocketAddr,
    },
    UpdateConnected {
        addr: PeerSocketAddr,
        services: PeerServices,
    },
    UpdateResponded {
        addr: PeerSocketAddr,
    },
    UpdateFailed {
        addr: PeerSocketAddr,
        services: Option<PeerServices>,
    },
}

A change to an existing MetaAddr.

Variants

NewInitial

Creates a MetaAddr for an initial peer.

Fields

addr: PeerSocketAddr

NewGossiped

Creates a new gossiped MetaAddr.

Fields

addr: PeerSocketAddr

untrusted_services: PeerServices

untrusted_last_seen: DateTime32

NewLocal

Creates new local listener MetaAddr.

Fields

addr: PeerSocketAddr

UpdateAttempt

Updates an existing MetaAddr when an outbound connection attempt starts.

Fields

addr: PeerSocketAddr

UpdateConnected

Updates an existing MetaAddr when we’ve made a successful connection with a peer.

Fields

addr: PeerSocketAddr

services: PeerServices

UpdateResponded

Updates an existing MetaAddr when a peer responds with a message.

Fields

addr: PeerSocketAddr

UpdateFailed

Updates an existing MetaAddr when a peer fails.

Fields

addr: PeerSocketAddr

services: Option<PeerServices>

Implementations

impl MetaAddrChange

pub fn addr_strategy(addr: PeerSocketAddr) -> BoxedStrategy<Self>

Returns a strategy which generates changes for addr.

addr is typically generated by the canonical_peer_addr strategy.

pub fn addr_changes_strategy( max_addr_change: usize, ) -> BoxedStrategy<(MetaAddr, Vec<MetaAddrChange>)>

Returns a strategy which generates a MetaAddr, and a vector of up to max_addr_change changes.

The address and the changes all have matching PeerSocketAddrs.

pub fn ready_outbound_strategy_ip() -> BoxedStrategy<IpAddr>

Create a strategy that generates IpAddrs for MetaAddrChanges which are ready for outbound connections.

pub fn ready_outbound_strategy_port() -> BoxedStrategy<u16>

Create a strategy that generates port numbers for MetaAddrs which are ready for outbound connections.

Currently, all generated MetaAddrs are the NeverAttemptedGossiped variant.

TODO: Generate all MetaAddr variants, and give them ready fields.

impl MetaAddrChange

pub fn addr(&self) -> PeerSocketAddr

Return the address for this change.

pub fn set_addr(&mut self, new_addr: PeerSocketAddr)

Set the address for this change to new_addr.

This method should only be used in tests.

pub fn untrusted_services(&self) -> Option<PeerServices>

Return the untrusted services for this change, if available.

pub fn untrusted_last_seen(&self, now: DateTime32) -> Option<DateTime32>

Return the untrusted last seen time for this change, if available.

pub fn last_attempt(&self, now: Instant) -> Option<Instant>

Return the last attempt for this change, if available.

pub fn last_response(&self, now: DateTime32) -> Option<DateTime32>

Return the last response for this change, if available.

pub fn last_failure(&self, now: Instant) -> Option<Instant>

Return the last failure for this change, if available.

pub fn peer_addr_state(&self) -> PeerAddrState

Return the peer connection state for this change.

pub fn into_new_meta_addr( self, instant_now: Instant, local_now: DateTime32, ) -> MetaAddr

Returns the corresponding MetaAddr for this change.

pub fn local_listener_into_new_meta_addr( self, local_now: DateTime32, ) -> MetaAddr

Returns the corresponding MetaAddr for a local listener change.

This method exists so we don’t have to provide an unused Instant to get a local listener MetaAddr.

Panics

If this change is not a MetaAddrChange::NewLocal.

pub fn apply_to_meta_addr( &self, previous: impl Into<Option<MetaAddr>>, instant_now: Instant, chrono_now: DateTime<Utc>, ) -> Option<MetaAddr>

Apply this change to a previous MetaAddr from the address book, producing a new or updated MetaAddr.

If the change isn’t valid for the previous address, returns None.

Trait Implementations

impl Arbitrary for MetaAddrChange

type Parameters = ((<PeerServices as Arbitrary>::Parameters, <DateTime32 as Arbitrary>::Parameters), <PeerServices as Arbitrary>::Parameters, <Option<PeerServices> as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = TupleUnion<((u32, Arc<Map<BoxedStrategy<PeerSocketAddr>, fn(_: PeerSocketAddr) -> MetaAddrChange>>), (u32, Arc<Map<(BoxedStrategy<PeerSocketAddr>, <PeerServices as Arbitrary>::Strategy, <DateTime32 as Arbitrary>::Strategy), fn(_: (PeerSocketAddr, PeerServices, DateTime32)) -> MetaAddrChange>>), (u32, Arc<Map<BoxedStrategy<PeerSocketAddr>, fn(_: PeerSocketAddr) -> MetaAddrChange>>), (u32, Arc<Map<BoxedStrategy<PeerSocketAddr>, fn(_: PeerSocketAddr) -> MetaAddrChange>>), (u32, Arc<Map<(BoxedStrategy<PeerSocketAddr>, <PeerServices as Arbitrary>::Strategy), fn(_: (PeerSocketAddr, PeerServices)) -> MetaAddrChange>>), (u32, Arc<Map<BoxedStrategy<PeerSocketAddr>, fn(_: PeerSocketAddr) -> MetaAddrChange>>), (u32, Arc<Map<(BoxedStrategy<PeerSocketAddr>, <Option<PeerServices> as Arbitrary>::Strategy), fn(_: (PeerSocketAddr, Option<PeerServices>)) -> MetaAddrChange>>))>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MetaAddrChange

fn clone(&self) -> MetaAddrChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetaAddrChange

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

Formats the value using the given formatter.

impl Extend<MetaAddrChange> for AddressBook

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = MetaAddrChange>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl PartialEq for MetaAddrChange

fn eq(&self, other: &MetaAddrChange) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MetaAddrChange

impl Eq for MetaAddrChange

impl StructuralPartialEq for MetaAddrChange