Struct libp2p_bitswap::Bitswap

pub struct Bitswap<P: StoreParams> { /* fields omitted */ }

Network behaviour that handles sending and receiving blocks.

Implementations

impl<P: StoreParams> Bitswap<P>

pub fn new<S: BitswapStore<Params = P>>(config: BitswapConfig, store: S) -> Self

Creates a new Bitswap behaviour.

pub fn add_address(&mut self, peer_id: &PeerId, addr: Multiaddr)

Adds an address for a peer.

pub fn remove_address(&mut self, peer_id: &PeerId, addr: &Multiaddr)

Removes an address for a peer.

pub fn get(
    &mut self,
    cid: Cid,
    initial: impl Iterator<Item = PeerId>
) -> QueryId

Starts a get query with an initial guess of providers.

pub fn sync(&mut self, cid: Cid, missing: impl Iterator<Item = Cid>) -> QueryId

Starts a sync query with an the initial set of missing blocks.

pub fn cancel(&mut self, id: QueryId) -> bool

Cancels an in progress query. Returns true if a query was cancelled.

pub fn inject_providers(&mut self, id: QueryId, providers: Vec<PeerId>)

Adds a provider for a cid. Used for handling the Providers event.

pub fn register_metrics(&self, registry: &Registry) -> Result<()>

Registers prometheus metrics.

Trait Implementations

impl<P: StoreParams> NetworkBehaviour for Bitswap<P>

type ProtocolsHandler = <Throttled<BitswapCodec<P>> as NetworkBehaviour>::ProtocolsHandler

Handler for all the protocols the network behaviour supports.

type OutEvent = BitswapEvent

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

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

Creates a new ProtocolsHandler for a connection with a peer.

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

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

fn inject_connected(&mut self, peer_id: &PeerId)

Indicates the behaviour that we connected to the node with the given peer id.

fn inject_disconnected(&mut self, peer_id: &PeerId)

Indicates the behaviour that we disconnected from the node with the given peer id.

fn inject_connection_established(
    &mut self,
    peer_id: &PeerId,
    conn: &ConnectionId,
    endpoint: &ConnectedPoint
)

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

fn inject_connection_closed(
    &mut self,
    peer_id: &PeerId,
    conn: &ConnectionId,
    endpoint: &ConnectedPoint
)

Informs the behaviour about a closed connection to a peer.

fn inject_addr_reach_failure(
    &mut self,
    peer_id: Option<&PeerId>,
    addr: &Multiaddr,
    error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

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

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

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

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

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

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

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

A listener experienced an error.

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

A listener closed.

fn inject_event(
    &mut self,
    peer_id: PeerId,
    conn: ConnectionId,
    event: <Self::ProtocolsHandler as ProtocolsHandler>::OutEvent
)

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

fn poll(
    &mut self,
    cx: &mut Context<'_>,
    pp: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<Self::ProtocolsHandler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.

pub fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

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