Struct libp2p_kad::handler::KademliaHandler

pub struct KademliaHandler<TUserData> { /* private fields */ }

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

impl<TUserData> KademliaHandler<TUserData>where TUserData: Clone + Debug + Send + 'static + Unpin,

pub fn new( config: KademliaHandlerConfig, endpoint: ConnectedPoint, remote_peer_id: PeerId ) -> Self

Create a KademliaHandler using the given configuration.

Trait Implementations

impl<TUserData> ConnectionHandler for KademliaHandler<TUserData>where TUserData: Clone + Debug + Send + 'static + Unpin,

type InEvent = KademliaHandlerIn<TUserData>

Custom event that can be received from the outside.

type OutEvent = KademliaHandlerEvent<TUserData>

Custom event that can be produced by the handler and that will be returned to the outside.

type Error = Error

The type of errors returned by ConnectionHandler::poll.

type InboundProtocol = EitherUpgrade<KademliaProtocolConfig, DeniedUpgrade>

The inbound upgrade for the protocol(s) used by the handler.

type OutboundProtocol = KademliaProtocolConfig

The outbound upgrade for the protocol(s) used by the handler.

type OutboundOpenInfo = (KadRequestMsg, Option<TUserData>)

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = ()

The type of additional information returned from listen_protocol.

fn listen_protocol( &self ) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>

The InboundUpgrade to apply on inbound substreams to negotiate the desired protocols.

fn on_behaviour_event(&mut self, message: KademliaHandlerIn<TUserData>)

Informs the handler about an event from the NetworkBehaviour.

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

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> )

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.

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.

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.

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.

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.

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.

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.

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.

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.