Struct libp2p::kad::handler::KademliaHandler
source · pub struct KademliaHandler<TUserData> { /* private fields */ }
Expand description
Protocol handler that manages substreams for the Kademlia protocol on a single connection with a peer.
The handler will automatically open a Kademlia substream with the remote for each request we make.
It also handles requests made by the remote.
Implementations§
source§impl<TUserData> KademliaHandler<TUserData>where
TUserData: Clone + Debug + Send + 'static + Unpin,
impl<TUserData> KademliaHandler<TUserData>where TUserData: Clone + Debug + Send + 'static + Unpin,
sourcepub fn new(
config: KademliaHandlerConfig,
endpoint: ConnectedPoint,
remote_peer_id: PeerId
) -> KademliaHandler<TUserData>
pub fn new( config: KademliaHandlerConfig, endpoint: ConnectedPoint, remote_peer_id: PeerId ) -> KademliaHandler<TUserData>
Create a KademliaHandler
using the given configuration.
Trait Implementations§
source§impl<TUserData> ConnectionHandler for KademliaHandler<TUserData>where
TUserData: Clone + Debug + Send + 'static + Unpin,
impl<TUserData> ConnectionHandler for KademliaHandler<TUserData>where TUserData: Clone + Debug + Send + 'static + Unpin,
§type InEvent = KademliaHandlerIn<TUserData>
type InEvent = KademliaHandlerIn<TUserData>
Custom event that can be received from the outside.
§type OutEvent = KademliaHandlerEvent<TUserData>
type OutEvent = KademliaHandlerEvent<TUserData>
Custom event that can be produced by the handler and that will be returned to the outside.
§type Error = Error
type Error = Error
The type of errors returned by
ConnectionHandler::poll
.§type InboundProtocol = EitherUpgrade<KademliaProtocolConfig, DeniedUpgrade>
type InboundProtocol = EitherUpgrade<KademliaProtocolConfig, DeniedUpgrade>
The inbound upgrade for the protocol(s) used by the handler.
§type OutboundProtocol = KademliaProtocolConfig
type OutboundProtocol = KademliaProtocolConfig
The outbound upgrade for the protocol(s) used by the handler.
§type OutboundOpenInfo = (KadRequestMsg, Option<TUserData>)
type OutboundOpenInfo = (KadRequestMsg, Option<TUserData>)
The type of additional information passed to an
OutboundSubstreamRequest
.§type InboundOpenInfo = ()
type InboundOpenInfo = ()
The type of additional information returned from
listen_protocol
.source§fn listen_protocol(
&self
) -> SubstreamProtocol<<KademliaHandler<TUserData> as ConnectionHandler>::InboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::InboundOpenInfo>
fn listen_protocol( &self ) -> SubstreamProtocol<<KademliaHandler<TUserData> as ConnectionHandler>::InboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::InboundOpenInfo>
The
InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read moresource§fn on_behaviour_event(&mut self, message: KademliaHandlerIn<TUserData>)
fn on_behaviour_event(&mut self, message: KademliaHandlerIn<TUserData>)
Informs the handler about an event from the
NetworkBehaviour
.source§fn connection_keep_alive(&self) -> KeepAlive
fn connection_keep_alive(&self) -> KeepAlive
Returns until when the connection should be kept alive. Read more
source§fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ConnectionHandlerEvent<<KademliaHandler<TUserData> as ConnectionHandler>::OutboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::OutboundOpenInfo, <KademliaHandler<TUserData> as ConnectionHandler>::OutEvent, <KademliaHandler<TUserData> as ConnectionHandler>::Error>>
fn poll( &mut self, cx: &mut Context<'_> ) -> Poll<ConnectionHandlerEvent<<KademliaHandler<TUserData> as ConnectionHandler>::OutboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::OutboundOpenInfo, <KademliaHandler<TUserData> as ConnectionHandler>::OutEvent, <KademliaHandler<TUserData> as ConnectionHandler>::Error>>
Should behave like
Stream::poll()
.fn on_connection_event( &mut self, event: ConnectionEvent<'_, <KademliaHandler<TUserData> as ConnectionHandler>::InboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::OutboundProtocol, <KademliaHandler<TUserData> as ConnectionHandler>::InboundOpenInfo, <KademliaHandler<TUserData> as ConnectionHandler>::OutboundOpenInfo> )
source§fn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output,
info: Self::InboundOpenInfo
)
fn inject_fully_negotiated_inbound( &mut self, protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output, info: Self::InboundOpenInfo )
👎Deprecated since 0.41.0: Handle
ConnectionEvent::FullyNegotiatedInbound
on ConnectionHandler::on_connection_event
instead.
The default implemention of this inject_*
method delegates to it.Injects the output of a successful upgrade on a new inbound substream. Read more
source§fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
info: Self::OutboundOpenInfo
)
fn inject_fully_negotiated_outbound( &mut self, protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output, info: Self::OutboundOpenInfo )
👎Deprecated since 0.41.0: Handle
ConnectionEvent::FullyNegotiatedOutbound
on ConnectionHandler::on_connection_event
instead.
The default implemention of this inject_*
method delegates to it.Injects the output of a successful upgrade on a new outbound substream. Read more
source§fn inject_event(&mut self, event: Self::InEvent)
fn inject_event(&mut self, event: Self::InEvent)
👎Deprecated since 0.41.0: Implement
ConnectionHandler::on_behaviour_event
instead. The default implementation of inject_event
delegates to it.Injects an event coming from the outside in the handler.
source§fn inject_address_change(&mut self, new_address: &Multiaddr)
fn inject_address_change(&mut self, new_address: &Multiaddr)
👎Deprecated since 0.41.0: Handle
ConnectionEvent::AddressChange
on ConnectionHandler::on_connection_event
instead.
The default implemention of this inject_*
method delegates to it.Notifies the handler of a change in the address of the remote.
source§fn inject_dial_upgrade_error(
&mut self,
info: Self::OutboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
fn inject_dial_upgrade_error( &mut self, info: Self::OutboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error> )
👎Deprecated since 0.41.0: Handle
ConnectionEvent::DialUpgradeError
on ConnectionHandler::on_connection_event
instead.
The default implemention of this inject_*
method delegates to it.Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
source§fn inject_listen_upgrade_error(
&mut self,
info: Self::InboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error( &mut self, info: Self::InboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error> )
👎Deprecated since 0.41.0: Handle
ConnectionEvent::ListenUpgradeError
on ConnectionHandler::on_connection_event
instead.
The default implemention of this inject_*
method delegates to it.Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
source§fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>where
Self: Sized,
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>where Self: Sized, TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
Adds a closure that turns the input event into something else.
source§fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>where
Self: Sized,
TMap: FnMut(Self::OutEvent) -> TNewOut,
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>where Self: Sized, TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
source§fn select<TProto2>(
self,
other: TProto2
) -> ConnectionHandlerSelect<Self, TProto2>where
Self: Sized,
fn select<TProto2>( self, other: TProto2 ) -> ConnectionHandlerSelect<Self, TProto2>where Self: Sized,
Creates a new
ConnectionHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read moreAuto Trait Implementations§
impl<TUserData> !RefUnwindSafe for KademliaHandler<TUserData>
impl<TUserData> Send for KademliaHandler<TUserData>where TUserData: Send,
impl<TUserData> !Sync for KademliaHandler<TUserData>
impl<TUserData> Unpin for KademliaHandler<TUserData>
impl<TUserData> !UnwindSafe for KademliaHandler<TUserData>
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> IntoConnectionHandler for Twhere
T: ConnectionHandler,
impl<T> IntoConnectionHandler for Twhere T: ConnectionHandler,
source§fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
Builds the protocols handler. Read more
source§fn inbound_protocol(
&self
) -> <<T as IntoConnectionHandler>::Handler as ConnectionHandler>::InboundProtocol
fn inbound_protocol( &self ) -> <<T as IntoConnectionHandler>::Handler as ConnectionHandler>::InboundProtocol
Return the handler’s inbound protocol.
source§fn select<TProto2>(
self,
other: TProto2
) -> IntoConnectionHandlerSelect<Self, TProto2>where
Self: Sized,
fn select<TProto2>( self, other: TProto2 ) -> IntoConnectionHandlerSelect<Self, TProto2>where Self: Sized,
Builds an implementation of
IntoConnectionHandler
that handles both this protocol and the
other one together.