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>
impl<TUserData> KademliaHandler<TUserData>
sourcepub fn new(
config: KademliaHandlerConfig,
endpoint: ConnectedPoint,
remote_peer_id: PeerId,
) -> Self
pub fn new( config: KademliaHandlerConfig, endpoint: ConnectedPoint, remote_peer_id: PeerId, ) -> Self
Create a KademliaHandler
using the given configuration.
Trait Implementations§
source§impl<TUserData> ConnectionHandler for KademliaHandler<TUserData>
impl<TUserData> ConnectionHandler for KademliaHandler<TUserData>
§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 = Either<KademliaProtocolConfig, DeniedUpgrade>
type InboundProtocol = Either<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 = ()
type OutboundOpenInfo = ()
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<Self::InboundProtocol, Self::InboundOpenInfo>
fn listen_protocol( &self, ) -> SubstreamProtocol<Self::InboundProtocol, Self::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<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
Should behave like
Stream::poll()
.fn on_connection_event( &mut self, event: ConnectionEvent<'_, Self::InboundProtocol, Self::OutboundProtocol, Self::InboundOpenInfo, Self::OutboundOpenInfo>, )
source§fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>
Adds a closure that turns the input event into something else.
source§fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>
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> !Freeze for KademliaHandler<TUserData>
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>where
TUserData: Unpin,
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,
§type Handler = T
type Handler = T
👎Deprecated: Implement
ConnectionHandler
directly and use NetworkBehaviour::{handle_pending_inbound_connection,handle_pending_outbound_connection}
to handle pending connections.The protocols handler.
source§fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
👎Deprecated: Implement
ConnectionHandler
directly and use NetworkBehaviour::{handle_pending_inbound_connection,handle_pending_outbound_connection}
to handle pending connections.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
👎Deprecated: Implement
ConnectionHandler
directly and use NetworkBehaviour::{handle_pending_inbound_connection,handle_pending_outbound_connection}
to handle pending connections.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,
👎Deprecated: Implement
ConnectionHandler
directly and use NetworkBehaviour::{handle_pending_inbound_connection,handle_pending_outbound_connection}
to handle pending connections.Builds an implementation of
IntoConnectionHandler
that handles both this protocol and the
other one together.