Struct Behaviour

pub struct Behaviour<S: Store> { /* private fields */ }

Behaviour that maintains a peer address book.

Usage:

use libp2p::swarm::NetworkBehaviour;
use libp2p_peer_store::{memory_store::MemoryStore, Behaviour};

// `identify::Behaviour` broadcasts listen addresses of the peer,
// `peer_store::Behaviour` will then capture the resulting
// `FromSwarm::NewExternalAddrOfPeer` and add the addresses
// to address book.
#[derive(NetworkBehaviour)]
struct ComposedBehaviour {
    peer_store: Behaviour<MemoryStore>,
    identify: libp2p::identify::Behaviour,
}

Implementations

impl<'a, S> Behaviour<S>

where S: Store + 'static,

pub fn new(store: S) -> Self

Build a new Behaviour with the given store.

pub fn address_of_peer<'b>( &'a self, peer: &'b PeerId, ) -> Option<impl Iterator<Item = &'a Multiaddr> + use<'a, 'b, S>>

Try to get all observed address of the given peer.
Returns None when the peer is not in the store.

pub fn store(&self) -> &S

Get an immutable reference to the internal store.

pub fn store_mut(&mut self) -> &mut S

Get a mutable reference to the internal store.

Trait Implementations

impl<S> NetworkBehaviour for Behaviour<S>

where S: Store + 'static, <S as Store>::FromStore: Send + Sync,

type ConnectionHandler = ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = Event<<S as Store>::FromStore>

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

fn handle_established_inbound_connection( &mut self, _connection_id: ConnectionId, _peer: PeerId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

fn handle_established_outbound_connection( &mut self, _connection_id: ConnectionId, _peer: PeerId, _addr: &Multiaddr, _role_override: Endpoint, _port_use: PortUse, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

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

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, _peer_id: PeerId, _connection_id: ConnectionId, _event: THandlerOutEvent<Self>, )

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

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.