Struct libp2p_autonat::Behaviour

pub struct Behaviour { /* private fields */ }

NetworkBehaviour for AutoNAT.

The behaviour frequently runs probes to determine whether the local peer is behind NAT and/ or a firewall, or publicly reachable. In a probe, a dial-back request is sent to a peer that is randomly selected from the list of fixed servers and connected peers. Upon receiving a dial-back request, the remote tries to dial the included addresses. When a first address was successfully dialed, a status Ok will be send back together with the dialed address. If no address can be reached a dial-error is send back. Based on the received response, the sender assumes themselves to be public or private. The status is retried in a frequency of Config::retry_interval or Config::retry_interval, depending on whether enough confidence in the assumed NAT status was reached or not. The confidence increases each time a probe confirms the assumed status, and decreases if a different status is reported. If the confidence is 0, the status is flipped and the Behaviour will report the new status in an OutEvent.

Implementations

impl Behaviour

pub fn new(local_peer_id: PeerId, config: Config) -> Self

pub fn public_address(&self) -> Option<&Multiaddr>

Assumed public address of the local peer. Returns None in case of status NatStatus::Private or NatStatus::Unknown.

pub fn nat_status(&self) -> NatStatus

Assumed NAT status.

pub fn confidence(&self) -> usize

Confidence in the assumed NAT status.

pub fn add_server(&mut self, peer: PeerId, address: Option<Multiaddr>)

Add a peer to the list over servers that may be used for probes. These peers are used for dial-request even if they are currently not connection, in which case a connection will be establish before sending the dial-request.

pub fn remove_server(&mut self, peer: &PeerId)

Remove a peer from the list of servers. See Behaviour::add_server for more info.

Trait Implementations

impl NetworkBehaviour for Behaviour

type ConnectionHandler = <RequestResponse<AutoNatCodec> as NetworkBehaviour>::ConnectionHandler

Handler for all the protocols the network behaviour supports.

type OutEvent = Event

Event generated by the NetworkBehaviour and that the swarm will report back.

fn poll(
    &mut self,
    cx: &mut Context<'_>,
    params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<Behaviour as NetworkBehaviour>::OutEvent, <Behaviour as NetworkBehaviour>::ConnectionHandler>>

Polls for things that swarm should do.

fn new_handler(&mut self) -> Self::ConnectionHandler

Creates a new ConnectionHandler for a connection with a peer.

fn addresses_of_peer(&mut self, peer: &PeerId) -> Vec<Multiaddr>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event(
    &mut self,
    peer_id: PeerId,
    connection_id: ConnectionId,
    event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)

Informs the behaviour about an event generated by the ConnectionHandler dedicated to the peer identified by peer_id. for the behaviour.

fn inject_connection_established(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    endpoint: &ConnectedPoint,
    failed_addresses: Option<&Vec<Multiaddr, Global>>,
    other_established: usize
)

👎Deprecated since 0.40.2: Handle FromSwarm::ConnectionEstablished in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    endpoint: &ConnectedPoint,
    handler: <Self::ConnectionHandler as IntoConnectionHandler>::Handler,
    remaining_established: usize
)

👎Deprecated since 0.40.2: Handle FromSwarm::ConnectionClosed in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    old: &ConnectedPoint,
    new: &ConnectedPoint
)

👎Deprecated since 0.40.2: Handle FromSwarm::AddressChange in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_event(
    &mut self,
    peer_id: PeerId,
    connection: ConnectionId,
    event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)

👎Deprecated since 0.40.2: Implement NetworkBehaviour::on_connection_handler_event instead. The default implementation of this inject_* method delegates to it.

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

fn inject_dial_failure(
    &mut self,
    peer_id: Option<PeerId>,
    handler: Self::ConnectionHandler,
    error: &DialError
)

👎Deprecated since 0.40.2: Handle InEvent::DialFailure in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that the dial to a known or unknown node failed.

fn inject_listen_failure(
    &mut self,
    local_addr: &Multiaddr,
    send_back_addr: &Multiaddr,
    handler: Self::ConnectionHandler
)

👎Deprecated since 0.40.2: Handle FromSwarm::ListenFailure in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that an error happened on an incoming connection during its initial handshake.

fn inject_new_listener(&mut self, id: ListenerId)

👎Deprecated since 0.40.2: Handle FromSwarm::NewListener in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::NewListenAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::ExpiredListenAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening on it.

fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))

👎Deprecated since 0.40.2: Handle FromSwarm::ListenerError in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

A listener experienced an error.

fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)

👎Deprecated since 0.40.2: Handle FromSwarm::ListenerClosed in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

A listener closed.

fn inject_new_external_addr(&mut self, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::NewExternalAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_expired_external_addr(&mut self, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::ExpiredExternalAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that an external address was removed.