ConfigOptions extension

Extension methods for Config options

on

Methods

withAddrsFactory(AddrsFactory factory) Future<void>

Available on Config, provided by the ConfigOptions extension

withAmbientAutoNAT(AmbientAutoNATv2Config conf) Future<void>

Available on Config, provided by the ConfigOptions extension

withAutoNAT(bool enabled) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to enable/disable the AutoNAT service.
withAutoNATv2AllowPrivateAddrs() Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 to allow private addresses (for testing)
withAutoNATv2AmplificationAttackPreventionDialWait(Duration duration) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 amplification attack prevention dial wait time
withAutoNATv2DataRequestPolicy(DataRequestPolicyFunc policy) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 with a custom data request policy
withAutoNATv2MetricsTracer(MetricsTracer metricsTracer) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 with a metrics tracer
withAutoNATv2Options(List<AutoNATv2Option> options) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 with specific options
withAutoNATv2ServerRateLimit(int rpm, int perPeerRPM, int dialDataRPM) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures AutoNATv2 server rate limits
withAutoRelay(bool enabled) Future<void>

Available on Config, provided by the ConfigOptions extension

withConnManager(ConnManager manager) Future<void>

Available on Config, provided by the ConfigOptions extension

withEventBus(EventBus bus) Future<void>

Available on Config, provided by the ConfigOptions extension

withHolePunching(bool enabled) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to enable/disable the Hole Punching service.
withIdentifyDisableObservedAddrManager(bool disable) Future<void>

Available on Config, provided by the ConfigOptions extension

withIdentifyDisableSignedPeerRecord(bool disable) Future<void>

Available on Config, provided by the ConfigOptions extension

withIdentifyProtocolVersion(String version) Future<void>

Available on Config, provided by the ConfigOptions extension

withIdentifyUserAgent(String agent) Future<void>

Available on Config, provided by the ConfigOptions extension

withIdentity(KeyPair keyPair) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given identity (private key).
withListenAddrs(List<MultiAddr> addrs) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given addresses.
withMuxer(String id, Multiplexer muxerFactory(Conn secureConn, bool isClient)) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given stream multiplexer.
withNatManager(NATManager factory(Network)) Future<void>

Available on Config, provided by the ConfigOptions extension

withNegotiationTimeout(Duration timeout) Future<void>

Available on Config, provided by the ConfigOptions extension

withNoSecurity() Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use no security (insecure connections).
withPing(bool enabled) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to enable/disable the Ping service.
withProtocolVersion(String version) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given protocol version.
withReachability(Reachability r) Future<void>

Available on Config, provided by the ConfigOptions extension

withRelay(bool enabled) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to enable/disable the Relay service.
withRelayServers(List<String> servers) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures relay servers to automatically connect to during startup
withSecurity(SecurityProtocol securityProtocol) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given security protocol.
withTransport(Transport transport) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given transport.
withUserAgent(String agent) Future<void>

Available on Config, provided by the ConfigOptions extension

Configures libp2p to use the given user agent.