Struct libp2p::kad::handler::KademliaHandler

pub struct KademliaHandler<TSubstream, TUserData> where
    TSubstream: AsyncRead + AsyncWrite,  { /* fields omitted */ }

Protocol handler that handles Kademlia communications with the remote.

The handler will automatically open a Kademlia substream with the remote for each request we make.

It also handles requests made by the remote.

Methods

impl<TSubstream, TUserData> KademliaHandler<TSubstream, TUserData> where
    TSubstream: AsyncRead + AsyncWrite, 

pub fn dial_only() -> KademliaHandler<TSubstream, TUserData>

Create a KademliaHandler that only allows sending messages to the remote but denying incoming connections.

pub fn dial_and_listen() -> KademliaHandler<TSubstream, TUserData>

Create a KademliaHandler that only allows sending messages but also receive incoming requests.

The Default trait implementation wraps around this function.

pub fn with_protocol_name<impl Into>>(
    self,
    name: impl Into>
) -> KademliaHandler<TSubstream, TUserData> where
    impl Into>: Into<Cow<'static, [u8]>>, 

Modifies the protocol name used on the wire. Can be used to create incompatibilities between networks on purpose.

Trait Implementations

impl<TSubstream, TUserData> ProtocolsHandler for KademliaHandler<TSubstream, TUserData> where
    TSubstream: AsyncRead + AsyncWrite,
    TUserData: Clone, 

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 Substream = TSubstream

The type of substreams on which the protocol(s) are negotiated.

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.

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

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

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <<KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<TSubstream>>::Output,
    <KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::OutboundOpenInfo
)

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

fn inject_fully_negotiated_inbound(
    &mut self,
    protocol: <<KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<TSubstream>>::Output
)

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

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

Injects an event coming from the outside in the handler.

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

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

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

fn poll(
    &mut self
) -> Result<Async<ProtocolsHandlerEvent<<KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::OutboundProtocol, <KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::OutboundOpenInfo, <KademliaHandler<TSubstream, TUserData> as ProtocolsHandler>::OutEvent>>, Error>

Should behave like Stream::poll().

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.

fn into_node_handler(self) -> NodeHandlerWrapper<Self>

Deprecated:

Use into_node_handler_builder instead

Builds an implementation of NodeHandler that handles this protocol exclusively.

impl<TSubstream, TUserData> Default for KademliaHandler<TSubstream, TUserData> where
    TSubstream: AsyncRead + AsyncWrite, 

fn default() -> KademliaHandler<TSubstream, TUserData>

Returns the "default value" for a type.