Struct zebra_network::Config

source · [−]

pub struct Config {
    pub listen_addr: SocketAddr,
    pub network: Network,
    pub initial_mainnet_peers: IndexSet<String>,
    pub initial_testnet_peers: IndexSet<String>,
    pub peerset_initial_target_size: usize,
    pub crawl_new_peer_interval: Duration,
}

Expand description

Configuration for networking code.

Fields

listen_addr: SocketAddr

The address on which this node should listen for connections.

Can be address:port or just address. If there is no configured port, Zebra will use the default port for the configured network.

address can be an IP address or a DNS name. DNS names are only resolved once, when Zebra starts up.

If a specific listener address is configured, Zebra will advertise it to other nodes. But by default, Zebra uses an unspecified address (“0.0.0.0” or “[::]”), which is not advertised to other nodes.

Zebra does not currently support:

However, other Zebra instances compensate for unspecified or incorrect listener addresses by adding the external IP addresses of peers to their address books.

network: Network

The network to connect to.

initial_mainnet_peers: IndexSet<String>

A list of initial peers for the peerset when operating on mainnet.

initial_testnet_peers: IndexSet<String>

A list of initial peers for the peerset when operating on testnet.

peerset_initial_target_size: usize

The initial target size for the peer set.

Also used to limit the number of inbound and outbound connections made by Zebra.

If you have a slow network connection, and Zebra is having trouble syncing, try reducing the peer set size. You can also reduce the peer set size to reduce Zebra’s bandwidth usage.

crawl_new_peer_interval: Duration

How frequently we attempt to crawl the network to discover new peer addresses.

Zebra asks its connected peers for more peer addresses:

regularly, every time crawl_new_peer_interval elapses, and
if the peer set is busy, and there aren’t any peer addresses for the next connection attempt.

Struct zebra_network::Config

Fields

Implementations

impl Config

pub fn peerset_outbound_connection_limit(&self) -> usize

pub fn peerset_inbound_connection_limit(&self) -> usize

pub fn peerset_total_connection_limit(&self) -> usize

pub fn initial_peer_hostnames(&self) -> &IndexSet<String>

pub async fn initial_peers(&self) -> HashSet<SocketAddr>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Default for Config

fn default() -> Config

impl<'de> Deserialize<'de> for Config

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

impl Serialize for Config

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

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self> where &'a Self: for<'a> IntoIterator,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,

impl<T, U> Into<U> for T where
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T> Pipe for T where
T: ?Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,

fn tap_borrow<B>(self, func: impl for<'_> FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl for<'_> FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,