pub struct Bitswap<P: StoreParams> { /* private fields */ }Expand description
Network behaviour that handles sending and receiving blocks.
Implementations§
Source§impl<P: StoreParams> Bitswap<P>
impl<P: StoreParams> Bitswap<P>
Sourcepub fn new<S: BitswapStore<Params = P>>(config: BitswapConfig, store: S) -> Self
pub fn new<S: BitswapStore<Params = P>>(config: BitswapConfig, store: S) -> Self
Creates a new Bitswap behaviour.
Sourcepub fn add_address(&mut self, peer_id: &PeerId, addr: Multiaddr)
pub fn add_address(&mut self, peer_id: &PeerId, addr: Multiaddr)
Adds an address for a peer.
Sourcepub fn remove_address(&mut self, peer_id: &PeerId, addr: &Multiaddr)
pub fn remove_address(&mut self, peer_id: &PeerId, addr: &Multiaddr)
Removes an address for a peer.
Sourcepub fn get(&mut self, cid: Cid, peers: impl Iterator<Item = PeerId>) -> QueryId
pub fn get(&mut self, cid: Cid, peers: impl Iterator<Item = PeerId>) -> QueryId
Starts a get query with an initial guess of providers.
Sourcepub fn sync(
&mut self,
cid: Cid,
peers: Vec<PeerId>,
missing: impl Iterator<Item = Cid>,
) -> QueryId
pub fn sync( &mut self, cid: Cid, peers: Vec<PeerId>, missing: impl Iterator<Item = Cid>, ) -> QueryId
Starts a sync query with an the initial set of missing blocks.
Sourcepub fn cancel(&mut self, id: QueryId) -> bool
pub fn cancel(&mut self, id: QueryId) -> bool
Cancels an in progress query. Returns true if a query was cancelled.
Sourcepub fn register_metrics(&self, registry: &Registry) -> Result<()>
pub fn register_metrics(&self, registry: &Registry) -> Result<()>
Registers prometheus metrics.
Trait Implementations§
Source§impl<P: StoreParams> NetworkBehaviour for Bitswap<P>
impl<P: StoreParams> NetworkBehaviour for Bitswap<P>
Source§type ConnectionHandler = <RequestResponse<BitswapCodec<P>> as NetworkBehaviour>::ConnectionHandler
type ConnectionHandler = <RequestResponse<BitswapCodec<P>> as NetworkBehaviour>::ConnectionHandler
Handler for all the protocols the network behaviour supports.
Source§type OutEvent = BitswapEvent
type OutEvent = BitswapEvent
Event generated by the
NetworkBehaviour and that the swarm will report back.Source§fn new_handler(&mut self) -> Self::ConnectionHandler
fn new_handler(&mut self) -> Self::ConnectionHandler
Creates a new
ConnectionHandler for a connection with a peer. Read moreSource§fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr>
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. Read more
Source§fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
Informs the behaviour about an event from the
Swarm.Source§fn on_connection_handler_event(
&mut self,
peer_id: PeerId,
conn: ConnectionId,
event: <Self::ConnectionHandler as ConnectionHandler>::OutEvent,
)
fn on_connection_handler_event( &mut self, peer_id: PeerId, conn: ConnectionId, event: <Self::ConnectionHandler as ConnectionHandler>::OutEvent, )
Informs the behaviour about an event generated by the
ConnectionHandler dedicated to the
peer identified by peer_id. for the behaviour. Read moreSource§fn poll(
&mut self,
cx: &mut Context<'_>,
pp: &mut impl PollParameters,
) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>
fn poll( &mut self, cx: &mut Context<'_>, pp: &mut impl PollParameters, ) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>
Polls for things that swarm should do. Read more
Source§fn inject_connection_established(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
endpoint: &ConnectedPoint,
failed_addresses: Option<&Vec<Multiaddr>>,
other_established: usize,
)
fn inject_connection_established( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, endpoint: &ConnectedPoint, failed_addresses: Option<&Vec<Multiaddr>>, 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.
Source§fn inject_connection_closed(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
endpoint: &ConnectedPoint,
handler: <Self::ConnectionHandler as IntoConnectionHandler>::Handler,
remaining_established: usize,
)
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. Read more
Source§fn inject_address_change(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
old: &ConnectedPoint,
new: &ConnectedPoint,
)
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.Source§fn inject_event(
&mut self,
peer_id: PeerId,
connection: ConnectionId,
event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent,
)
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. Read moreSource§fn inject_dial_failure(
&mut self,
peer_id: Option<PeerId>,
handler: Self::ConnectionHandler,
error: &DialError,
)
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.
Source§fn inject_listen_failure(
&mut self,
local_addr: &Multiaddr,
send_back_addr: &Multiaddr,
handler: Self::ConnectionHandler,
)
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. Read more
Source§fn inject_new_listener(&mut self, id: ListenerId)
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.
Source§fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
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.
Source§fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &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.
Source§fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))
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.
Source§fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &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.
Source§fn inject_new_external_addr(&mut self, addr: &Multiaddr)
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.
Source§fn inject_expired_external_addr(&mut self, addr: &Multiaddr)
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.
Auto Trait Implementations§
impl<P> Freeze for Bitswap<P>
impl<P> !RefUnwindSafe for Bitswap<P>
impl<P> Send for Bitswap<P>
impl<P> !Sync for Bitswap<P>
impl<P> Unpin for Bitswap<P>
impl<P> !UnwindSafe for Bitswap<P>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more