Struct ipfs_embed::NetworkConfig

pub struct NetworkConfig {

    pub enable_loopback: bool,
    pub port_reuse: bool,
    pub node_name: String,
    pub node_key: Keypair,
    pub psk: Option<[u8; 32]>,
    pub dns: Option<DnsConfig>,
    pub mdns: Option<MdnsConfig>,
    pub kad: Option<KadConfig>,
    pub ping: Option<PingConfig>,
    pub identify: Option<IdentifyConfig>,
    pub gossipsub: Option<GossipsubConfig>,
    pub broadcast: Option<BroadcastConfig>,
    pub bitswap: Option<BitswapConfig>,
    pub keep_alive: bool,
}

Network configuration.

Fields

enable_loopback: bool

Enable adding loopback addresses to the address book. Should be enabled during testing and disabled in production.

port_reuse: bool

Enable binding to the listen port number when dialling peers instead of using a random outgoing port. While this may allow stricter firewall confiuration or shorter peer lists when interacting with other IPFS implementations, it also opens up the possibility of TCP simultaneous open, which leads to spurious dial errors.

node_name: String

Node name.

node_key: Keypair

Node key.

psk: Option<[u8; 32]>

Pre shared key.

dns: Option<DnsConfig>

Dns config. If no dns config is provided the system defaults will be used.

mdns: Option<MdnsConfig>

Mdns config.

kad: Option<KadConfig>

Kad config.

ping: Option<PingConfig>

Ping config.

identify: Option<IdentifyConfig>

Identify config. Note that the node_name and node_key will overwrite the local_public_key and the agent_version.

gossipsub: Option<GossipsubConfig>

Gossipsub config.

broadcast: Option<BroadcastConfig>

Broadcast config.

bitswap: Option<BitswapConfig>

Bitswap config.

keep_alive: bool

Keep explicitly dialed and incoming connections open indefinitely

Implementations

impl NetworkConfig

pub fn new(node_key: Keypair) -> Self

Creates a new network configuration.

Trait Implementations

impl Debug for NetworkConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NetworkConfig

fn default() -> Self

Returns the “default value” for a type.