Struct libp2p::core::Network

pub struct Network<TTrans, TInEvent, TOutEvent, THandler, TConnInfo = PeerId, TPeerId = PeerId> where
    THandler: IntoConnectionHandler<TConnInfo>,
    TTrans: Transport,  { /* fields omitted */ }

Implementation of Stream that handles the nodes.

Implementations

impl<TTrans, TInEvent, TOutEvent, TMuxer, THandler, TConnInfo, TPeerId> Network<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> where
    TConnInfo: Debug + ConnectionInfo<PeerId = TPeerId> + Send + 'static,
    THandler: IntoConnectionHandler<TConnInfo> + Send + 'static,
    TMuxer: StreamMuxer,
    TPeerId: Eq + Hash + Clone,
    TTrans: Transport + Clone,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: ConnectionHandler,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: Send,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: 'static,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::OutboundOpenInfo: Send,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::OutboundOpenInfo: 'static,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: Error,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: Send,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: 'static,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Substream == SubstreamRef<Arc<TMuxer>>,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::InEvent == TInEvent,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::OutEvent == TOutEvent, 

pub fn new(
    transport: TTrans,
    local_peer_id: TPeerId,
    config: NetworkConfig
) -> Network<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId>

Creates a new node events stream.

pub fn transport(&self) -> &TTrans

Returns the transport passed when building this object.

pub fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<<TTrans as Transport>::Error>>

Start listening on the given multiaddress.

pub fn remove_listener(&mut self, id: ListenerId) -> Result<(), ()>

Remove a previously added listener.

Returns Ok(()) if a listener with this ID was in the list.

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

Returns an iterator that produces the list of addresses we are listening on.

pub fn address_translation<'a>(
    &'a self,
    observed_addr: &'a Multiaddr
) -> impl Iterator<Item = Multiaddr> + 'a where
    THandler: 'a,
    TMuxer: 'a, 

Call this function in order to know which address remotes should dial to access your local node.

When receiving an observed address on a tcp connection that we initiated, the observed address contains our tcp dial port, not our tcp listen port. We know which port we are listening on, thereby we can replace the port within the observed address.

When receiving an observed address on a tcp connection that we did not initiated, the observed address should contain our listening port. In case it differs from our listening port there might be a proxy along the path.

Arguments

• observed_addr - should be an address a remote observes you as, which can be obtained for example with the identify protocol.

pub fn local_peer_id(&self) -> &TPeerId

Returns the peer id of the local node.

pub fn dial(
    &mut self,
    address: &Multiaddr,
    handler: THandler
) -> Result<ConnectionId, ConnectionLimit> where
    TConnInfo: Send + 'static,
    TInEvent: Send + 'static,
    TMuxer: Send + Sync + 'static,
    TOutEvent: Send + 'static,
    TPeerId: Send + 'static,
    TTrans: Transport<Output = (TConnInfo, TMuxer)>,
    <TTrans as Transport>::Error: Send,
    <TTrans as Transport>::Error: 'static,
    <TTrans as Transport>::Dial: Send,
    <TTrans as Transport>::Dial: 'static,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send, 

Dials a multiaddress without expecting a particular remote peer ID.

The given handler will be used to create the Connection upon success and the connection ID is returned.

pub fn info(&self) -> NetworkInfo

Returns information about the state of the Network.

pub fn incoming_info(&self) -> impl Iterator<Item = IncomingInfo<'_>>

Returns an iterator for information on all pending incoming connections.

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

Returns the list of addresses we're currently dialing without knowing the PeerId of.

pub fn connected_peers(&self) -> impl Iterator<Item = &TPeerId>

Returns a list of all connected peers, i.e. peers to whom the Network has at least one established connection.

pub fn is_connected(&self, peer: &TPeerId) -> bool

Checks whether the network has an established connection to a peer.

pub fn is_dialing(&self, peer: &TPeerId) -> bool

Checks whether the network has an ongoing dialing attempt to a peer.

pub fn is_disconnected(&self, peer: &TPeerId) -> bool

Checks whether the network has neither an ongoing dialing attempt, nor an established connection to a peer.

pub fn dialing_peers(&self) -> impl Iterator<Item = &TPeerId>

Returns a list of all the peers to whom a new outgoing connection is currently being established.

pub fn incoming_limit(&self) -> Option<usize>

Gets the configured limit on pending incoming connections, i.e. concurrent incoming connection attempts.

pub fn num_connections_established(&self) -> usize

The total number of established connections in the Network.

pub fn num_connections_pending(&self) -> usize

The total number of pending connections in the Network.

pub fn peer(
    &mut self,
    peer_id: TPeerId
) -> Peer<'_, TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId>

Obtains a view of a Peer with the given ID in the network.

pub fn accept(
    &mut self,
    connection: IncomingConnection<<TTrans as Transport>::ListenerUpgrade>,
    handler: THandler
) -> Result<ConnectionId, ConnectionLimit> where
    TInEvent: Send + 'static,
    TMuxer: StreamMuxer + Send + Sync + 'static,
    TOutEvent: Send + 'static,
    TPeerId: Send + 'static,
    TTrans: Transport<Output = (TConnInfo, TMuxer)>,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send,
    <TTrans as Transport>::Error: Send,
    <TTrans as Transport>::Error: 'static,
    <TTrans as Transport>::ListenerUpgrade: Send,
    <TTrans as Transport>::ListenerUpgrade: 'static, 

Accepts a pending incoming connection obtained via NetworkEvent::IncomingConnection, adding it to the Networks connection pool subject to the configured limits.

Once the connection is established and all transport protocol upgrades completed, the connection is associated with the provided handler.

pub fn poll(
    &'a mut self,
    cx: &mut Context<'_>
) -> Poll<NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId>> where
    TConnInfo: Clone,
    THandler: IntoConnectionHandler<TConnInfo> + Send + 'static,
    TInEvent: Send + 'static,
    TMuxer: Send + Sync + 'static,
    TOutEvent: Send + 'static,
    TPeerId: Send + 'static,
    TTrans: Transport<Output = (TConnInfo, TMuxer)>,
    <TTrans as Transport>::Error: Send,
    <TTrans as Transport>::Error: 'static,
    <TTrans as Transport>::Dial: Send,
    <TTrans as Transport>::Dial: 'static,
    <TTrans as Transport>::ListenerUpgrade: Send,
    <TTrans as Transport>::ListenerUpgrade: 'static,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: ConnectionHandler,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: Send,
    <THandler as IntoConnectionHandler<TConnInfo>>::Handler: 'static,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: Error,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: Send,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error: 'static,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Substream == SubstreamRef<Arc<TMuxer>>,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::InEvent == TInEvent,
    <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::OutEvent == TOutEvent, 

Provides an API similar to Stream, except that it cannot error.

Trait Implementations

impl<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> Debug for Network<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> where
    TConnInfo: Debug,
    THandler: Debug + ConnectionHandler,
    TPeerId: Debug + Eq + Hash,
    TTrans: Debug + Transport, 

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

Formats the value using the given formatter.

impl<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> Unpin for Network<TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> where
    THandler: IntoConnectionHandler<TConnInfo>,
    TTrans: Transport,