Struct libp2p_identify::Config

source ·
#[non_exhaustive]
pub struct Config { pub protocol_version: String, pub local_public_key: PublicKey, pub agent_version: String, pub initial_delay: Duration, pub interval: Duration, pub push_listen_addr_updates: bool, pub cache_size: usize, }
Expand description

Configuration for the identify::Behaviour.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§protocol_version: String

Application-specific version of the protocol family used by the peer, e.g. ipfs/1.0.0 or polkadot/1.0.0.

§local_public_key: PublicKey

The public key of the local node. To report on the wire.

§agent_version: String

Name and version of the local peer implementation, similar to the User-Agent header in the HTTP protocol.

Defaults to rust-libp2p/<libp2p-identify-version>.

§initial_delay: Duration

The initial delay before the first identification request is sent to a remote on a newly established connection.

Defaults to 500ms.

§interval: Duration

The interval at which identification requests are sent to the remote on established connections after the first request, i.e. the delay between identification requests.

Defaults to 5 minutes.

§push_listen_addr_updates: bool

Whether new or expired listen addresses of the local node should trigger an active push of an identify message to all connected peers.

Enabling this option can result in connected peers being informed earlier about new or expired listen addresses of the local node, i.e. before the next periodic identify request with each peer.

Disabled by default.

§cache_size: usize

How many entries of discovered peers to keep before we discard the least-recently used one.

Disabled by default.

Implementations§

Creates a new configuration for the identify Behaviour that advertises the given protocol version and public key.

Configures the agent version sent to peers.

Configures the initial delay before the first identification request is sent on a newly established connection to a peer.

Configures the interval at which identification requests are sent to peers after the initial request.

Configures whether new or expired listen addresses of the local node should trigger an active push of an identify message to all connected peers.

Configures the size of the LRU cache, caching addresses of discovered peers.

The Swarm may extend the set of addresses of an outgoing connection attempt via Behaviour::addresses_of_peer.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.