Struct DiscoveryArgs

pub struct DiscoveryArgs {

    pub disable_discovery: bool,
    pub disable_dns_discovery: bool,
    pub disable_discv4_discovery: bool,
    pub enable_discv5_discovery: bool,
    pub disable_nat: bool,
    pub addr: IpAddr,
    pub port: u16,
    pub discv5_addr: Option<Ipv4Addr>,
    pub discv5_addr_ipv6: Option<Ipv6Addr>,
    pub discv5_port: u16,
    pub discv5_port_ipv6: u16,
    pub discv5_lookup_interval: u64,
    pub discv5_bootstrap_lookup_interval: u64,
    pub discv5_bootstrap_lookup_countdown: u64,
}

Arguments to setup discovery

Fields

disable_discovery: bool

Disable the discovery service.

disable_dns_discovery: bool

Disable the DNS discovery.

disable_discv4_discovery: bool

Disable Discv4 discovery.

enable_discv5_discovery: bool

Enable Discv5 discovery.

disable_nat: bool

Disable Nat discovery.

addr: IpAddr

The UDP address to use for devp2p peer discovery version 4.

port: u16

The UDP port to use for devp2p peer discovery version 4.

discv5_addr: Option<Ipv4Addr>

The UDP IPv4 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it’s also IPv4.

discv5_addr_ipv6: Option<Ipv6Addr>

The UDP IPv6 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it’s also IPv6.

discv5_port: u16

The UDP IPv4 port to use for devp2p peer discovery version 5. Not used unless --addr is IPv4, or --discovery.v5.addr is set.

discv5_port_ipv6: u16

The UDP IPv6 port to use for devp2p peer discovery version 5. Not used unless --addr is IPv6, or --discovery.addr.ipv6 is set.

discv5_lookup_interval: u64

The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program.

discv5_bootstrap_lookup_interval: u64

The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap.

discv5_bootstrap_lookup_countdown: u64

The number of times to carry out boost lookup queries at bootstrap.

Implementations

impl DiscoveryArgs

pub fn apply_to_builder<N>( &self, network_config_builder: NetworkConfigBuilder<N>, rlpx_tcp_socket: SocketAddr, boot_nodes: impl IntoIterator<Item = NodeRecord>, ) -> NetworkConfigBuilder<N>

where N: NetworkPrimitives,

Apply the discovery settings to the given NetworkConfigBuilder

pub fn discovery_v5_builder( &self, rlpx_tcp_socket: SocketAddr, boot_nodes: impl IntoIterator<Item = NodeRecord>, ) -> ConfigBuilder

Creates a reth_discv5::ConfigBuilder filling it with the values from this struct.

pub const fn with_unused_discovery_port(self) -> Self

Set the discovery port to zero, to allow the OS to assign a random unused port when discovery binds to the socket.

pub fn adjust_instance_ports(&mut self, instance: u16)

Change networking port numbers based on the instance number. Ports are updated to previous_value + instance - 1

Panics

Warning: if instance is zero in debug mode, this will panic.

Trait Implementations

impl Args for DiscoveryArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for DiscoveryArgs

fn clone(&self) -> DiscoveryArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiscoveryArgs

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

Formats the value using the given formatter.

impl Default for DiscoveryArgs

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for DiscoveryArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for DiscoveryArgs

fn eq(&self, other: &DiscoveryArgs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DiscoveryArgs

impl StructuralPartialEq for DiscoveryArgs

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 80 bytes