Struct libp2p::swarm::SwarmBuilder

source ·
pub struct SwarmBuilder<TBehaviour> { /* private fields */ }
Expand description

A SwarmBuilder provides an API for configuring and constructing a Swarm.

Implementations§

source§

impl<TBehaviour> SwarmBuilder<TBehaviour>where TBehaviour: NetworkBehaviour,

source

pub fn new( transport: Boxed<(PeerId, StreamMuxerBox)>, behaviour: TBehaviour, local_peer_id: PeerId ) -> SwarmBuilder<TBehaviour>

👎Deprecated since 0.41.0: Use SwarmBuilder::with_executor or SwarmBuilder::without_executor instead.

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

source

pub fn with_executor( transport: Boxed<(PeerId, StreamMuxerBox)>, behaviour: TBehaviour, local_peer_id: PeerId, executor: impl Executor + Send + 'static ) -> SwarmBuilder<TBehaviour>

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

source

pub fn with_tokio_executor( transport: Boxed<(PeerId, StreamMuxerBox)>, behaviour: TBehaviour, local_peer_id: PeerId ) -> SwarmBuilder<TBehaviour>

Builds a new SwarmBuilder from the given transport, behaviour, local peer ID and a tokio executor.

source

pub fn without_executor( transport: Boxed<(PeerId, StreamMuxerBox)>, behaviour: TBehaviour, local_peer_id: PeerId ) -> SwarmBuilder<TBehaviour>

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

⚠️ Performance warning

All connections will be polled on the current task, thus quite bad performance characteristics should be expected. Whenever possible use an executor and SwarmBuilder::with_executor.

source

pub fn executor( self, executor: Box<dyn Executor + Send, Global> ) -> SwarmBuilder<TBehaviour>

👎Deprecated since 0.41.0: Use SwarmBuilder::with_executor instead.

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.

source

pub fn notify_handler_buffer_size( self, n: NonZeroUsize ) -> SwarmBuilder<TBehaviour>

Configures the number of events from the NetworkBehaviour in destination to the ConnectionHandler that can be buffered before the Swarm has to wait. An individual buffer with this number of events exists for each individual connection.

The ideal value depends on the executor used, the CPU speed, and the volume of events. If this value is too low, then the Swarm will be sleeping more often than necessary. Increasing this value increases the overall memory usage.

source

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

Configures the number of extra events from the ConnectionHandler in destination to the NetworkBehaviour that can be buffered before the ConnectionHandler has to go to sleep.

There exists a buffer of events received from ConnectionHandlers that the NetworkBehaviour has yet to process. This buffer is shared between all instances of ConnectionHandler. Each instance of ConnectionHandler is guaranteed one slot in this buffer, meaning that delivering an event for the first time is guaranteed to be instantaneous. Any extra event delivery, however, must wait for that first event to be delivered or for an “extra slot” to be available.

This option configures the number of such “extra slots” in this shared buffer. These extra slots are assigned in a first-come, first-served basis.

The ideal value depends on the executor used, the CPU speed, the average number of connections, and the volume of events. If this value is too low, then the ConnectionHandlers will be sleeping more often than necessary. Increasing this value increases the overall memory usage, and more importantly the latency between the moment when an event is emitted and the moment when it is received by the NetworkBehaviour.

source

pub fn dial_concurrency_factor( self, factor: NonZeroU8 ) -> SwarmBuilder<TBehaviour>

Number of addresses concurrently dialed for a single outbound connection attempt.

source

pub fn connection_limits( self, limits: ConnectionLimits ) -> SwarmBuilder<TBehaviour>

Configures the connection limits.

source

pub fn substream_upgrade_protocol_override( self, v: Version ) -> SwarmBuilder<TBehaviour>

Configures an override for the substream upgrade protocol to use.

The subtream upgrade protocol is the multistream-select protocol used for protocol negotiation on substreams. Since a listener supports all existing versions, the choice of upgrade protocol only effects the “dialer”, i.e. the peer opening a substream.

Note: If configured, specific upgrade protocols for individual SubstreamProtocols emitted by the NetworkBehaviour are ignored.

source

pub fn max_negotiating_inbound_streams( self, v: usize ) -> SwarmBuilder<TBehaviour>

The maximum number of inbound streams concurrently negotiating on a connection. New inbound streams exceeding the limit are dropped and thus reset.

Note: This only enforces a limit on the number of concurrently negotiating inbound streams. The total number of inbound streams on a connection is the sum of negotiating and negotiated streams. A limit on the total number of streams can be enforced at the StreamMuxerBox level.

source

pub fn build(self) -> Swarm<TBehaviour>

Builds a Swarm with the current configuration.

Auto Trait Implementations§

§

impl<TBehaviour> !RefUnwindSafe for SwarmBuilder<TBehaviour>

§

impl<TBehaviour> Send for SwarmBuilder<TBehaviour>where TBehaviour: Send,

§

impl<TBehaviour> !Sync for SwarmBuilder<TBehaviour>

§

impl<TBehaviour> Unpin for SwarmBuilder<TBehaviour>where TBehaviour: Unpin,

§

impl<TBehaviour> !UnwindSafe for SwarmBuilder<TBehaviour>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more