Skip to main content

ReachabilityInfo

Struct ReachabilityInfo 

Source
pub struct ReachabilityInfo {
    pub addresses: Vec<SocketAddr>,
    pub nat_type: Option<String>,
    pub can_receive_direct: Option<bool>,
    pub is_relay: Option<bool>,
    pub is_coordinator: Option<bool>,
    pub reachable_via: Vec<MachineId>,
    pub relay_candidates: Vec<MachineId>,
}
Expand description

Summarises the connectivity properties of a discovered agent.

Built from a DiscoveredAgent and used to decide which connection strategy to attempt.

Fields§

§addresses: Vec<SocketAddr>

Agent’s known addresses.

§nat_type: Option<String>

NAT type reported by the agent (e.g. “FullCone”, “Symmetric”). None when the agent has not yet reported NAT information.

This is informational only. Connection strategy should not infer direct reachability from NAT type alone.

§can_receive_direct: Option<bool>

Whether the agent can receive direct inbound connections. None when not reported.

§is_relay: Option<bool>

Whether the agent advertises relay service capability. None when not reported.

§is_coordinator: Option<bool>

Whether the agent advertises coordinator capability. None when not reported.

§reachable_via: Vec<MachineId>

Coordinator machines through which the advertising peer is reachable.

Prefer these when can_receive_direct == Some(false) — the peer has explicitly named who can hole-punch for them.

§relay_candidates: Vec<MachineId>

Relay machines the peer proposes as a fallback.

Implementations§

Source§

impl ReachabilityInfo

Source

pub fn from_discovered(agent: &DiscoveredAgent) -> Self

Build from a DiscoveredAgent.

Source

pub fn from_discovered_machine(machine: &DiscoveredMachine) -> Self

Build from a DiscoveredMachine.

Source

pub fn likely_direct(&self) -> bool

Returns true if the remote agent has observer-verified direct reachability.

Source

pub fn should_attempt_direct(&self) -> bool

Returns true if it is still worth attempting a direct connection.

Unknown reachability should still get a direct probe, especially for new networks where the first nodes have not yet accumulated observations.

Source

pub fn needs_coordination(&self) -> bool

Returns true if coordinated NAT traversal may be needed to connect.

Any agent that is not positively known to be directly reachable may still need coordination after direct attempts are exhausted.

Source

pub fn is_relay(&self) -> bool

Returns true if the agent advertises relay service capability.

Source

pub fn is_coordinator(&self) -> bool

Returns true if the agent advertises coordinator capability.

Trait Implementations§

Source§

impl Clone for ReachabilityInfo

Source§

fn clone(&self) -> ReachabilityInfo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReachabilityInfo

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more