Struct libp2p_kad::handler::KademliaHandler

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

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.

Implementations

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

pub fn dial_only() -> Self

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

pub fn dial_and_listen() -> Self

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

The Default trait implementation wraps around this function.

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.

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

Error that can happen when polling.

type Substream = TSubstream

The type of the substream that contains the raw data.

type InboundProtocol = EitherUpgrade<KademliaProtocolConfig, DeniedUpgrade>

The upgrade for the protocol or protocols handled by this handler.

type OutboundProtocol = KademliaProtocolConfig

The upgrade for the protocol or protocols handled by this handler.

type OutboundOpenInfo = (KadRequestMsg, Option<TUserData>)

Information about a substream. Can be sent to the handler through a NodeHandlerEndpoint, and will be passed back in inject_substream or inject_outbound_closed.

fn listen_protocol(&self) -> Self::InboundProtocol

Produces a ConnectionUpgrade for the protocol or protocols to accept when listening.

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <Self::OutboundProtocol as OutboundUpgrade<TSubstream>>::Output,
    (msg, user_data): Self::OutboundOpenInfo
)

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

Injects a fully-negotiated substream in the handler.

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

Injects an event coming from the outside in the handler.

fn inject_inbound_closed(&mut self)

Indicates to the handler that the inbound part of the muxer has been closed, and that therefore no more inbound substreams will be produced.

fn inject_dial_upgrade_error(
    &mut self,
    (_, user_data): Self::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<Error>
)

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

fn shutdown(&mut self)

Indicates to the node that it should shut down. After that, it is expected that poll() returns Ready(None) as soon as possible.

fn poll(
    &mut self
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent>, Error>

Should behave like Stream::poll(). Should close if no more event can be produced and the node should be closed.

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) -> ProtocolsHandlerSelect<Self, TProto2>where
    Self: Sized,

Builds an implementation of ProtocolsHandler that handles both this protocol and the other one together.

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>where
    Self: Sized,

Creates a builder that will allow creating a NodeHandler that handles this protocol exclusively.

fn into_node_handler(self) -> NodeHandlerWrapper<Self>where
    Self: Sized,

Builds an implementation of NodeHandler that handles this protocol exclusively.