Struct grin_p2p::types::P2PConfig

pub struct P2PConfig {
    pub host: IpAddr,
    pub port: u16,
    pub seeding_type: Seeding,
    pub seeds: Option<PeerAddrs>,
    pub capabilities: Capabilities,
    pub peers_allow: Option<PeerAddrs>,
    pub peers_deny: Option<PeerAddrs>,
    pub peers_preferred: Option<PeerAddrs>,
    pub ban_window: Option<i64>,
    pub peer_max_inbound_count: Option<u32>,
    pub peer_max_outbound_count: Option<u32>,
    pub peer_min_preferred_outbound_count: Option<u32>,
    pub peer_listener_buffer_count: Option<u32>,
    pub dandelion_peer: Option<PeerAddr>,
}

Configuration for the peer-to-peer server.

Fields

host: IpAddr

port: u16

seeding_type: Seeding

Method used to get the list of seed nodes for initial bootstrap.

seeds: Option<PeerAddrs>

The list of seed nodes, if using Seeding as a seed type

capabilities: Capabilities

Capabilities expose by this node, also conditions which other peers this node will have an affinity toward when connection.

peers_allow: Option<PeerAddrs>

peers_deny: Option<PeerAddrs>

peers_preferred: Option<PeerAddrs>

The list of preferred peers that we will try to connect to

ban_window: Option<i64>

peer_max_inbound_count: Option<u32>

peer_max_outbound_count: Option<u32>

peer_min_preferred_outbound_count: Option<u32>

peer_listener_buffer_count: Option<u32>

dandelion_peer: Option<PeerAddr>

Methods

impl P2PConfig

Note certain fields are options just so they don't have to be included in grin-server.toml, but we don't want them to ever return none

pub fn ban_window(&self) -> i64

return ban window

pub fn peer_max_inbound_count(&self) -> u32

return maximum inbound peer connections count

pub fn peer_max_outbound_count(&self) -> u32

return maximum outbound peer connections count

pub fn peer_min_preferred_outbound_count(&self) -> u32

return minimum preferred outbound peer count

pub fn peer_listener_buffer_count(&self) -> u32

return peer buffer count for listener

Trait Implementations

impl Clone for P2PConfig

fn clone(&self) -> P2PConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for P2PConfig

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

Formats the value using the given formatter.

impl Default for P2PConfig

Default address for peer-to-peer connections.

fn default() -> P2PConfig

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for P2PConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<P2PConfig> for P2PConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for P2PConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for P2PConfig