pub struct Config { /* private fields */ }
Implementations§
source§impl Config
impl Config
sourcepub fn with_executor(executor: impl Executor + Send + 'static) -> Config
pub fn with_executor(executor: impl Executor + Send + 'static) -> Config
Creates a new Config
from the given executor. The Swarm
is obtained via
Swarm::new
.
sourcepub fn with_wasm_executor() -> Config
Available on crate feature wasm-bindgen
only.
pub fn with_wasm_executor() -> Config
wasm-bindgen
only.Sets executor to the wasm
executor.
Background tasks will be executed by the browser on the next micro-tick.
Spawning a task is similar too:
function spawn(task: () => Promise<void>) {
task()
}
sourcepub fn with_tokio_executor() -> Config
Available on crate feature tokio
and neither Emscripten nor WASI nor target_os="unknown"
only.
pub fn with_tokio_executor() -> Config
tokio
and neither Emscripten nor WASI nor target_os="unknown"
only.Builds a new Config
from the given tokio
executor.
sourcepub fn with_async_std_executor() -> Config
Available on crate feature async-std
and neither Emscripten nor WASI nor target_os="unknown"
only.
pub fn with_async_std_executor() -> Config
async-std
and neither Emscripten nor WASI nor target_os="unknown"
only.Builds a new Config
from the given async-std
executor.
sourcepub fn with_notify_handler_buffer_size(self, n: NonZeroUsize) -> Config
pub fn with_notify_handler_buffer_size(self, n: NonZeroUsize) -> Config
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.
sourcepub fn with_per_connection_event_buffer_size(self, n: usize) -> Config
pub fn with_per_connection_event_buffer_size(self, n: usize) -> Config
Configures the size of the buffer for events sent by a ConnectionHandler
to the
NetworkBehaviour
.
Each connection has its own buffer.
The ideal value depends on the executor used, the CPU speed and the volume of events.
If this value is too low, then the ConnectionHandler
s 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
.
sourcepub fn with_dial_concurrency_factor(self, factor: NonZeroU8) -> Config
pub fn with_dial_concurrency_factor(self, factor: NonZeroU8) -> Config
Number of addresses concurrently dialed for a single outbound connection attempt.
sourcepub fn with_substream_upgrade_protocol_override(self, v: Version) -> Config
pub fn with_substream_upgrade_protocol_override(self, v: Version) -> Config
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
SubstreamProtocol
s emitted by theNetworkBehaviour
are ignored.
sourcepub fn with_max_negotiating_inbound_streams(self, v: usize) -> Config
pub fn with_max_negotiating_inbound_streams(self, v: usize) -> Config
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.
sourcepub fn with_idle_connection_timeout(self, timeout: Duration) -> Config
pub fn with_idle_connection_timeout(self, timeout: Duration) -> Config
How long to keep a connection alive once it is idling.
Defaults to 0.