Struct libp2p_gossipsub::protocol::ProtocolConfig
source · [−]pub struct ProtocolConfig { /* private fields */ }Expand description
Implementation of InboundUpgrade and OutboundUpgrade for the Gossipsub protocol.
Implementations
sourceimpl ProtocolConfig
impl ProtocolConfig
sourcepub fn new(
id_prefix: Cow<'static, str>,
max_transmit_size: usize,
validation_mode: ValidationMode,
support_floodsub: bool
) -> 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
sourceimpl Clone for ProtocolConfig
impl Clone for ProtocolConfig
sourcefn clone(&self) -> ProtocolConfig
fn clone(&self) -> ProtocolConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<TSocket> InboundUpgrade<TSocket> for ProtocolConfig where
TSocket: AsyncRead + AsyncWrite + Unpin + Send + 'static,
impl<TSocket> InboundUpgrade<TSocket> for ProtocolConfig where
TSocket: AsyncRead + AsyncWrite + Unpin + Send + 'static,
type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)
type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = GossipsubHandlerError
type Error = GossipsubHandlerError
Possible error during the handshake.
type Future = Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send>>
type Future = Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send>>
Future that performs the handshake with the remote.
sourcefn upgrade_inbound(
self,
socket: TSocket,
protocol_id: Self::Info
) -> Self::Future
fn upgrade_inbound(
self,
socket: TSocket,
protocol_id: Self::Info
) -> Self::Future
After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
sourceimpl<TSocket> OutboundUpgrade<TSocket> for ProtocolConfig where
TSocket: AsyncWrite + AsyncRead + Unpin + Send + 'static,
impl<TSocket> OutboundUpgrade<TSocket> for ProtocolConfig where
TSocket: AsyncWrite + AsyncRead + Unpin + Send + 'static,
type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)
type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = GossipsubHandlerError
type Error = GossipsubHandlerError
Possible error during the handshake.
type Future = Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send>>
type Future = Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send>>
Future that performs the handshake with the remote.
sourcefn upgrade_outbound(
self,
socket: TSocket,
protocol_id: Self::Info
) -> Self::Future
fn upgrade_outbound(
self,
socket: TSocket,
protocol_id: Self::Info
) -> Self::Future
After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
sourceimpl UpgradeInfo for ProtocolConfig
impl UpgradeInfo for ProtocolConfig
type Info = ProtocolId
type Info = ProtocolId
Opaque type representing a negotiable protocol.
sourcefn protocol_info(&self) -> Self::InfoIter
fn protocol_info(&self) -> Self::InfoIter
Returns the list of protocols that are supported. Used during the negotiation process.
Auto Trait Implementations
impl RefUnwindSafe for ProtocolConfig
impl Send for ProtocolConfig
impl Sync for ProtocolConfig
impl Unpin for ProtocolConfig
impl UnwindSafe for ProtocolConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,
impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>,
sourcefn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
Returns a new object that wraps around Self and applies a closure to the Output.
sourcefn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
Returns a new object that wraps around Self and applies a closure to the Error.
sourceimpl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
sourcefn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
Returns a new object that wraps around Self and applies a closure to the Output.
sourcefn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
Returns a new object that wraps around Self and applies a closure to the Error.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more