Struct libp2p_kad::handler::KademliaHandler [−][src]
pub struct KademliaHandler<TUserData> { /* fields omitted */ }
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
Create a KademliaHandler
using the given configuration.
Trait Implementations
impl<TUserData> ProtocolsHandler for KademliaHandler<TUserData> where
TUserData: Clone + Debug + Send + 'static,
impl<TUserData> ProtocolsHandler for KademliaHandler<TUserData> where
TUserData: Clone + Debug + Send + 'static,
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.
The type of errors returned by ProtocolsHandler::poll
.
The inbound upgrade for the protocol(s) used by the handler.
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
.
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgrade<NegotiatedSubstream>>::Output,
(msg, user_data): Self::OutboundOpenInfo
)
fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgrade<NegotiatedSubstream>>::Output,
(msg, user_data): Self::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
fn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output,
(): Self::InboundOpenInfo
)
fn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output,
(): Self::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
Injects an event coming from the outside in the handler.
fn inject_dial_upgrade_error(
&mut self,
(_, user_data): Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<Error>
)
fn inject_dial_upgrade_error(
&mut self,
(_, user_data): Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
Returns until when the connection should be kept alive. Read more
fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
Should behave like Stream::poll()
.
Notifies the handler of a change in the address of the remote.
fn inject_listen_upgrade_error(
&mut self,
Self::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error(
&mut self,
Self::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
Adds a closure that turns the input event into something else.
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
Creates a new ProtocolsHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read more
Creates a builder that allows creating a NodeHandler
that handles this protocol
exclusively. Read more
Auto Trait Implementations
impl<TUserData> !RefUnwindSafe for KademliaHandler<TUserData>
impl<TUserData> Send for KademliaHandler<TUserData> where
TUserData: Send,
impl<TUserData> Sync for KademliaHandler<TUserData> where
TUserData: Sync,
impl<TUserData> Unpin for KademliaHandler<TUserData> where
TUserData: Unpin,
impl<TUserData> !UnwindSafe for KademliaHandler<TUserData>
Blanket Implementations
Mutably borrows from an owned value. Read more
type Handler = T
type Handler = T
The protocols handler.
Builds the protocols handler. Read more
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
Return the handler’s inbound protocol.
Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the
other one together. Read more
Creates a builder that will allow creating a NodeHandler
that handles this protocol
exclusively. Read more