Struct pea2pea::NodeConfig

pub struct NodeConfig {

    pub name: Option<String>,
    pub listener_ip: IpAddr,
    pub desired_listening_port: Option<u16>,
    pub allow_random_port: bool,
    pub protocol_handler_queue_depth: usize,
    pub conn_read_buffer_size: usize,
    pub conn_write_buffer_size: usize,
    pub conn_inbound_queue_depth: usize,
    pub conn_outbound_queue_depth: usize,
    pub invalid_read_delay_secs: u64,
    pub fatal_io_errors: Vec<ErrorKind>,
    pub max_connections: u16,
    pub max_handshake_time_ms: u64,
}

The node’s configuration.

Fields

name: Option<String>

The name/identifier of the node.

note: if set to None, the Node will automatically be assigned a sequential, zero-based numeric identifier.

listener_ip: IpAddr

The IP address the node’s connection listener should bind to.

desired_listening_port: Option<u16>

The desired listening port of the node.

allow_random_port: bool

Allow listening on a different port if desired_listening_port is unavailable.

protocol_handler_queue_depth: usize

The depth of the queues passing connections to protocol handlers.

conn_read_buffer_size: usize

The size of a per-connection buffer for reading inbound messages.

conn_write_buffer_size: usize

The size of a per-connection buffer for writing outbound messages.

conn_inbound_queue_depth: usize

The depth of per-connection queues used to process inbound messages.

conn_outbound_queue_depth: usize

The depth of per-connection queues used to send outbound messages.

invalid_read_delay_secs: u64

The delay on the next read attempt from a connection that can’t be read from.

fatal_io_errors: Vec<ErrorKind>

The list of IO errors considered fatal and causing the connection to be dropped.

max_connections: u16

The maximum number of active connections the node can maintain.

note: this number can very briefly be breached by 1 in case of inbound connection attempts. It can never be breached by outbound connection attempts, though.

max_handshake_time_ms: u64

The maximum time allowed for a connection to perform a handshake before it is rejected.

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl Default for NodeConfig

fn default() -> Self

Returns the “default value” for a type.