Struct libp2p::gossipsub::protocol::ProtocolConfig

pub struct ProtocolConfig { /* fields omitted */ }

Implementation of InboundUpgrade and OutboundUpgrade for the Gossipsub protocol.

Implementations

impl ProtocolConfig

pub fn new(
    id_prefix: Cow<'static, str>,
    max_transmit_size: usize,
    validation_mode: ValidationMode,
    support_floodsub: bool
) -> ProtocolConfig

Builds a new ProtocolConfig.

Sets the maximum gossip transmission size.

Trait Implementations

impl Clone for ProtocolConfig

pub fn clone(&self) -> ProtocolConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TSocket> InboundUpgrade<TSocket> for ProtocolConfig where
    TSocket: AsyncRead + AsyncWrite + Unpin + Send + 'static, 

type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)

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

type Error = GossipsubHandlerError

Possible error during the handshake.

type Future = Pin<Box<dyn Future<Output = Result<<ProtocolConfig as InboundUpgrade<TSocket>>::Output, <ProtocolConfig as InboundUpgrade<TSocket>>::Error>> + 'static + Send, Global>>

Future that performs the handshake with the remote.

pub fn upgrade_inbound(
    self,
    socket: TSocket,
    protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as InboundUpgrade<TSocket>>::Future

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

impl<TSocket> OutboundUpgrade<TSocket> for ProtocolConfig where
    TSocket: AsyncWrite + AsyncRead + Unpin + Send + 'static, 

type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)

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

type Error = GossipsubHandlerError

Possible error during the handshake.

type Future = Pin<Box<dyn Future<Output = Result<<ProtocolConfig as OutboundUpgrade<TSocket>>::Output, <ProtocolConfig as OutboundUpgrade<TSocket>>::Error>> + 'static + Send, Global>>

Future that performs the handshake with the remote.

pub fn upgrade_outbound(
    self,
    socket: TSocket,
    protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as OutboundUpgrade<TSocket>>::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 ProtocolConfig

type Info = ProtocolId

Opaque type representing a negotiable protocol.

type InfoIter = Vec<<ProtocolConfig as UpgradeInfo>::Info, Global>

Iterator returned by protocol_info.

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

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