Skip to main content

RelayManager

Struct RelayManager 

Source
pub struct RelayManager { /* private fields */ }
Expand description

Manages relay connections for NAT traversal

Implementations§

Source§

impl RelayManager

Source

pub fn new(config: RelayManagerConfig) -> Self

Create a new relay manager with the given configuration

Source

pub fn config(&self) -> &RelayManagerConfig

Get the configuration

Source

pub fn add_relay(&mut self, address: Multiaddr)

Add a new relay address to connect to

Source

pub fn remove_relay(&mut self, address: &Multiaddr) -> Option<RelayInfo>

Remove a relay address

Source

pub fn get_relay(&self, address: &Multiaddr) -> Option<&RelayInfo>

Get relay info by address

Source

pub fn get_relay_mut(&mut self, address: &Multiaddr) -> Option<&mut RelayInfo>

Get mutable relay info by address

Source

pub fn get_relay_by_peer(&self, peer_id: &PeerId) -> Option<&RelayInfo>

Get relay info by peer ID

Source

pub fn get_relay_by_peer_mut( &mut self, peer_id: &PeerId, ) -> Option<&mut RelayInfo>

Get mutable relay info by peer ID

Source

pub fn relay_addresses(&self) -> impl Iterator<Item = &Multiaddr>

Get all relay addresses

Source

pub fn active_relay_addresses(&self) -> impl Iterator<Item = &Multiaddr>

Get all active relay addresses

Source

pub fn active_relay_count(&self) -> usize

Get number of active relays

Source

pub fn needs_more_relays(&self) -> bool

Check if we need more relay connections

Source

pub fn relays_to_connect(&self) -> Vec<Multiaddr>

Get relays that should be (re)connected

Source

pub fn mark_connecting(&mut self, address: &Multiaddr)

Mark a relay as connecting

Source

pub fn mark_connected(&mut self, address: &Multiaddr, peer_id: PeerId)

Mark a relay as connected

Source

pub fn mark_failed(&mut self, address: &Multiaddr, reason: String)

Mark a relay as failed

Source

pub fn mark_listening(&mut self, peer_id: &PeerId, circuit_address: Multiaddr)

Mark a relay as listening (p2p-circuit address active)

Source

pub fn circuit_addresses(&self) -> Vec<Multiaddr>

Get all p2p-circuit addresses we’re listening on

Source

pub fn stats(&self) -> RelayStats

Get statistics about relay connections

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<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> Same for T

Source§

type Output = T

Should always be Self
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