Show / Hide Table of Contents

Class SwarmOptions

Configuration options for communication with other peers.

Inheritance
Object
SwarmOptions
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Ipfs.Engine
Assembly: Ipfs.Engine.dll
Syntax
public class SwarmOptions

Properties

| Improve this Doc View Source

MinConnections

The low water mark for peer connections.

Declaration
public int MinConnections { get; set; }
Property Value
Type Description
Int32

Defaults to 0.

Remarks

The AutoDialer is used to maintain at least this number of connections.

This is an opt-feature. The value must be positive to enable it.

| Improve this Doc View Source

PrivateNetworkKey

The key of the private network.

Declaration
public PreSharedKey PrivateNetworkKey { get; set; }
Property Value
Type Description
PreSharedKey

The key must either null or 32 bytes (256 bits) in length.

Remarks

When null, the public network is used. Otherwise, the network is considered private and only peers with the same key will be communicated with.

When using a private network, the BootstrapPeers must also use this key.

See Also
https://github.com/libp2p/specs/blob/master/pnet/Private-Networks-PSK-V1.md

See Also

IpfsEngineOptions
  • Improve this Doc
  • View Source
Back to top Generated by DocFX