Struct libp2p::core::network::NetworkConfig

[+] Show declaration

pub struct NetworkConfig { /* fields omitted */ }

[−] Expand description

The (optional) configuration for a Network.

The default configuration specifies no dedicated task executor, no connection limits, a connection event buffer size of 32, and a notify_handler buffer size of 8.

Implementations

impl NetworkConfig[−]

pub fn with_executor(
    self,
    e: Box<dyn Executor + 'static + Send, Global>
) -> NetworkConfig[−]

Configures the executor to use for spawning connection background tasks.

pub fn or_else_with_executor<F>(self, f: F) -> NetworkConfig where
    F: FnOnce() -> Option<Box<dyn Executor + 'static + Send, Global>>, [−]

Configures the executor to use for spawning connection background tasks, only if no executor has already been configured.

pub fn with_notify_handler_buffer_size(self, n: NonZeroUsize) -> NetworkConfig[−]

Sets the maximum number of events sent to a connection’s background task that may be buffered, if the task cannot keep up with their consumption and delivery to the connection handler.

When the buffer for a particular connection is full, notify_handler will no longer be able to deliver events to the associated ConnectionHandler, thus exerting back-pressure on the connection and peer API.

pub fn with_connection_event_buffer_size(self, n: usize) -> NetworkConfig[−]

Sets the maximum number of buffered connection events (beyond a guaranteed buffer of 1 event per connection).

When the buffer is full, the background tasks of all connections will stall. In this way, the consumers of network events exert back-pressure on the network connection I/O.

pub fn with_connection_limits(self, limits: ConnectionLimits) -> NetworkConfig[−]

Sets the connection limits to enforce.

Trait Implementations

impl Default for NetworkConfig[+]

[+] Show hidden undocumented items

pub fn default() -> NetworkConfig[−]

Returns the “default value” for a type.