Struct libp2p::kad::protocol::KademliaProtocolConfig

pub struct KademliaProtocolConfig { /* fields omitted */ }

Configuration for a Kademlia connection upgrade. When applied to a connection, turns this connection into a Stream + Sink whose items are of type KadRequestMsg and KadResponseMsg.

Implementations

impl KademliaProtocolConfig

pub fn protocol_name(&self) -> &[u8]

Returns the configured protocol name.

pub fn set_protocol_name(&mut self, name: impl Into<Cow<'static, [u8]>>)

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

pub fn set_max_packet_size(&mut self, size: usize)

Modifies the maximum allowed size of a single Kademlia packet.

Trait Implementations

impl Clone for KademliaProtocolConfig

pub fn clone(&self) -> KademliaProtocolConfig

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KademliaProtocolConfig

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for KademliaProtocolConfig

pub fn default() -> KademliaProtocolConfig

Returns the "default value" for a type.

impl<C> InboundUpgrade<C> for KademliaProtocolConfig where
    C: AsyncRead + AsyncWrite + Unpin, 

type Output = AndThen<With<ErrInto<Framed<C, UviBytes<Cursor<Vec<u8, Global>>>>, Error>, Cursor<Vec<u8, Global>>, KadResponseMsg, Ready<Result<Cursor<Vec<u8, Global>>, Error>>, fn(KadResponseMsg) -> Ready<Result<Cursor<Vec<u8, Global>>, Error>>>, Ready<Result<KadRequestMsg, Error>>, fn(BytesMut) -> Ready<Result<KadRequestMsg, Error>>>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Future = Ready<Result<<KademliaProtocolConfig as InboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

type Error = Error

Possible error during the handshake.

pub fn upgrade_inbound(
    self,
    incoming: C,
    <KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as InboundUpgrade<C>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl<C> OutboundUpgrade<C> for KademliaProtocolConfig where
    C: AsyncRead + AsyncWrite + Unpin, 

type Output = AndThen<With<ErrInto<Framed<C, UviBytes<Cursor<Vec<u8, Global>>>>, Error>, Cursor<Vec<u8, Global>>, KadRequestMsg, Ready<Result<Cursor<Vec<u8, Global>>, Error>>, fn(KadRequestMsg) -> Ready<Result<Cursor<Vec<u8, Global>>, Error>>>, Ready<Result<KadResponseMsg, Error>>, fn(BytesMut) -> Ready<Result<KadResponseMsg, Error>>>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Future = Ready<Result<<KademliaProtocolConfig as OutboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

type Error = Error

Possible error during the handshake.

pub fn upgrade_outbound(
    self,
    incoming: C,
    <KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as OutboundUpgrade<C>>::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl UpgradeInfo for KademliaProtocolConfig

type Info = Cow<'static, [u8]>

Opaque type representing a negotiable protocol.

type InfoIter = Once<<KademliaProtocolConfig as UpgradeInfo>::Info>

Iterator returned by protocol_info.

pub fn protocol_info(&self) -> <KademliaProtocolConfig as UpgradeInfo>::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.