Struct sc_network_common::config::NonDefaultSetConfig

pub struct NonDefaultSetConfig {
    pub notifications_protocol: ProtocolName,
    pub fallback_names: Vec<ProtocolName>,
    pub handshake: Option<NotificationHandshake>,
    pub max_notification_size: u64,
    pub set_config: SetConfig,
}

Extension to SetConfig for sets that aren’t the default set.

Note: As new fields might be added in the future, please consider using the new method and modifiers instead of creating this struct manually.

Fields

notifications_protocol: ProtocolName

Name of the notifications protocols of this set. A substream on this set will be considered established once this protocol is open.

Note: This field isn’t present for the default set, as this is handled internally by the networking code.

fallback_names: Vec<ProtocolName>

If the remote reports that it doesn’t support the protocol indicated in the notifications_protocol field, then each of these fallback names will be tried one by one.

If a fallback is used, it will be reported in sc_network::protocol::event::Event::NotificationStreamOpened::negotiated_fallback

handshake: Option<NotificationHandshake>

Handshake of the protocol

NOTE: Currently custom handshakes are not fully supported. See issue #5685 for more details. This field is temporarily used to allow moving the hardcoded block announcement protocol out of protocol.rs.

max_notification_size: u64

Maximum allowed size of single notifications.

set_config: SetConfig

Base configuration.

Implementations

impl NonDefaultSetConfig

pub fn new(
    notifications_protocol: ProtocolName,
    max_notification_size: u64
) -> Self

Creates a new NonDefaultSetConfig. Zero slots and accepts only reserved nodes.

pub fn allow_non_reserved(&mut self, in_peers: u32, out_peers: u32)

Modifies the configuration to allow non-reserved nodes.

pub fn add_reserved(&mut self, peer: MultiaddrWithPeerId)

Add a node to the list of reserved nodes.

pub fn add_fallback_names(&mut self, fallback_names: Vec<ProtocolName>)

Add a list of protocol names used for backward compatibility.

See the explanations in NonDefaultSetConfig::fallback_names.

Trait Implementations

impl Clone for NonDefaultSetConfig

fn clone(&self) -> NonDefaultSetConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NonDefaultSetConfig

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

Formats the value using the given formatter.