Struct libp2p::swarm::SwarmBuilder

pub struct SwarmBuilder<TBehaviour, TConnInfo> { /* fields omitted */ }

A SwarmBuilder provides an API for configuring and constructing a Swarm, including the underlying [Network].

Methods

impl<TBehaviour, TConnInfo> SwarmBuilder<TBehaviour, TConnInfo> where
    TBehaviour: NetworkBehaviour,
    TConnInfo: ConnectionInfo<PeerId = PeerId> + Debug + Clone + Send + 'static, 

pub fn new<TTrans, TMuxer>(
    transport: TTrans,
    behaviour: TBehaviour,
    local_peer_id: PeerId
) -> SwarmBuilder<TBehaviour, TConnInfo> where
    TMuxer: StreamMuxer + Send + Sync + 'static,
    TTrans: Transport<Output = (TConnInfo, TMuxer)> + Clone + Send + Sync + 'static,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send,
    <TMuxer as StreamMuxer>::OutboundSubstream: 'static,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send,
    <TMuxer as StreamMuxer>::OutboundSubstream: 'static,
    <TMuxer as StreamMuxer>::Substream: Send,
    <TMuxer as StreamMuxer>::Substream: 'static,
    <TTrans as Transport>::Error: Send,
    <TTrans as Transport>::Error: Sync,
    <TTrans as Transport>::Error: 'static,
    <TTrans as Transport>::Listener: Send,
    <TTrans as Transport>::Listener: 'static,
    <TTrans as Transport>::ListenerUpgrade: Send,
    <TTrans as Transport>::ListenerUpgrade: 'static,
    <TTrans as Transport>::Dial: Send,
    <TTrans as Transport>::Dial: 'static, 

Creates a new SwarmBuilder from the given transport, behaviour and local peer ID. The Swarm with its underlying Network is obtained via [SwarmBuilder::build].

pub fn executor(
    self,
    e: Box<dyn Executor + 'static + Send>
) -> SwarmBuilder<TBehaviour, TConnInfo>

Configures the Executor to use for spawning background tasks.

By default, unless another executor has been configured, [SwarmBuilder::build] will try to set up a ThreadPool.

pub fn incoming_connection_limit(
    self,
    n: usize
) -> SwarmBuilder<TBehaviour, TConnInfo>

Configures a limit for the number of simultaneous incoming connection attempts.

pub fn outgoing_connection_limit(
    self,
    n: usize
) -> SwarmBuilder<TBehaviour, TConnInfo>

Configures a limit for the number of simultaneous outgoing connection attempts.

pub fn peer_connection_limit(
    self,
    n: usize
) -> SwarmBuilder<TBehaviour, TConnInfo>

Configures a limit for the number of simultaneous established connections per peer.

pub fn build(
    self
) -> ExpandedSwarm<TBehaviour, <<<TBehaviour as NetworkBehaviour>::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent, <<<TBehaviour as NetworkBehaviour>::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent, <TBehaviour as NetworkBehaviour>::ProtocolsHandler, TConnInfo>

Builds a Swarm with the current configuration.