Struct libp2p::kad::handler::KademliaHandler

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

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>

pub fn new(
    config: KademliaHandlerConfig,
    endpoint: ConnectedPoint
) -> KademliaHandler<TUserData>

Create a KademliaHandler using the given configuration.

Trait Implementations

impl<TUserData> ProtocolsHandler for KademliaHandler<TUserData> where
    TUserData: Clone + Send + 'static, 

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 ProtocolsHandler::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.

pub fn listen_protocol(
    &self
) -> SubstreamProtocol<<KademliaHandler<TUserData> as ProtocolsHandler>::InboundProtocol, <KademliaHandler<TUserData> as ProtocolsHandler>::InboundOpenInfo>

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

pub fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <<KademliaHandler<TUserData> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
    <KademliaHandler<TUserData> as ProtocolsHandler>::OutboundOpenInfo
)

Injects the output of a successful upgrade on a new outbound substream.

pub fn inject_fully_negotiated_inbound(
    &mut self,
    protocol: <<KademliaHandler<TUserData> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
    <KademliaHandler<TUserData> as ProtocolsHandler>::InboundOpenInfo
)

Injects the output of a successful upgrade on a new inbound substream.

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

Injects an event coming from the outside in the handler.

pub fn inject_dial_upgrade_error(
    &mut self,
    <KademliaHandler<TUserData> as ProtocolsHandler>::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<Error>
)

Indicates to the handler that upgrading an outbound substream to the given protocol has failed.

pub fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

pub fn poll(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<KademliaHandler<TUserData> as ProtocolsHandler>::OutboundProtocol, <KademliaHandler<TUserData> as ProtocolsHandler>::OutboundOpenInfo, <KademliaHandler<TUserData> as ProtocolsHandler>::OutEvent, <KademliaHandler<TUserData> as ProtocolsHandler>::Error>>

Should behave like Stream::poll().

fn inject_address_change(&mut self, _new_address: &Multiaddr)

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

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

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, 

Adds a closure that turns the output event into something else.

fn select<TProto2>(
    self,
    other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>

Creates a new ProtocolsHandler that selects either this handler or other by delegating methods calls appropriately.

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

Creates a builder that allows creating a NodeHandler that handles this protocol exclusively.