Struct libp2p_core::swarm::PollParameters

pub struct PollParameters<'a, TTopology: 'a> { /* private fields */ }

Parameters passed to poll() that the NetworkBehaviour has access to.

Implementations

impl<'a, TTopology> PollParameters<'a, TTopology>

pub fn topology(&mut self) -> &mut TTopology

Returns a reference to the topology of the network.

pub fn supported_protocols(&self) -> impl ExactSizeIterator<Item = &[u8]>

Returns the list of protocol the behaviour supports when a remote negotiates a protocol on an inbound substream.

The iterator’s elements are the ASCII names as reported on the wire.

Note that the list is computed once at initialization and never refreshed.

pub fn listened_addresses(&self) -> impl ExactSizeIterator<Item = &Multiaddr>

Returns the list of the addresses we’re listening on.

pub fn external_addresses<'b>(
    &'b mut self
) -> impl ExactSizeIterator<Item = Multiaddr> + 'bwhere
    TTopology: Topology,

Returns the list of the addresses nodes can use to reach us.

pub fn local_public_key(&self) -> &PublicKeywhere
    TTopology: Topology,

Returns the public key of the local node.

pub fn local_peer_id(&self) -> &PeerIdwhere
    TTopology: Topology,

Returns the peer id of the local node.

pub fn nat_traversal(
    &self,
    server: &Multiaddr,
    observed: &Multiaddr
) -> Option<Multiaddr>

Calls the nat_traversal method on the underlying transport of the Swarm.