Struct sc_network::config::NetworkConfiguration[][src]

pub struct NetworkConfiguration {
    pub net_config_path: Option<PathBuf>,
    pub listen_addresses: Vec<Multiaddr>,
    pub public_addresses: Vec<Multiaddr>,
    pub boot_nodes: Vec<MultiaddrWithPeerId>,
    pub node_key: NodeKeyConfig,
    pub notifications_protocols: Vec<(ConsensusEngineId, Cow<'static, str>)>,
    pub request_response_protocols: Vec<RequestResponseConfig>,
    pub in_peers: u32,
    pub out_peers: u32,
    pub reserved_nodes: Vec<MultiaddrWithPeerId>,
    pub non_reserved_mode: NonReservedPeerMode,
    pub client_version: String,
    pub node_name: String,
    pub transport: TransportConfig,
    pub max_parallel_downloads: u32,
    pub allow_non_globals_in_dht: bool,
}

Network service configuration.

Fields

net_config_path: Option<PathBuf>

Directory path to store network-specific configuration. None means nothing will be saved.

listen_addresses: Vec<Multiaddr>

Multiaddresses to listen for incoming connections.

public_addresses: Vec<Multiaddr>

Multiaddresses to advertise. Detected automatically if empty.

boot_nodes: Vec<MultiaddrWithPeerId>

List of initial node addresses

node_key: NodeKeyConfig

The node key configuration, which determines the node’s network identity keypair.

notifications_protocols: Vec<(ConsensusEngineId, Cow<'static, str>)>

List of notifications protocols that the node supports. Must also include a ConsensusEngineId for backwards-compatibility.

request_response_protocols: Vec<RequestResponseConfig>

List of request-response protocols that the node supports.

in_peers: u32

Maximum allowed number of incoming connections.

out_peers: u32

Number of outgoing connections we’re trying to maintain.

reserved_nodes: Vec<MultiaddrWithPeerId>

List of reserved node addresses.

non_reserved_mode: NonReservedPeerMode

The non-reserved peer mode.

client_version: String

Client identifier. Sent over the wire for debugging purposes.

node_name: String

Name of the node. Sent over the wire for debugging purposes.

transport: TransportConfig

Configuration for the transport layer.

max_parallel_downloads: u32

Maximum number of peers to ask the same blocks in parallel.

allow_non_globals_in_dht: bool

Should we insert non-global addresses into the DHT?

Implementations

impl NetworkConfiguration[src]

pub fn new<SN: Into<String>, SV: Into<String>>(
    node_name: SN,
    client_version: SV,
    node_key: NodeKeyConfig,
    net_config_path: Option<PathBuf>
) -> Self
[src]

Create new default configuration

pub fn new_local() -> NetworkConfiguration[src]

Create new default configuration for localhost-only connection with random port (useful for testing)

pub fn new_memory() -> NetworkConfiguration[src]

Create new default configuration for localhost-only connection with random port (useful for testing)

Trait Implementations

impl Clone for NetworkConfiguration[src]

impl Debug for NetworkConfiguration[src]

Auto Trait Implementations

impl !RefUnwindSafe for NetworkConfiguration

impl Send for NetworkConfiguration

impl Sync for NetworkConfiguration

impl Unpin for NetworkConfiguration

impl !UnwindSafe for NetworkConfiguration

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> CheckedConversion for T[src]

impl<T> DynClone for T where
    T: Clone
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, Outer> IsWrappedBy<Outer> for T where
    T: From<Outer>,
    Outer: AsRef<T> + AsMut<T> + From<T>, 
[src]

pub fn from_ref(outer: &Outer) -> &T[src]

Get a reference to the inner from the outer.

pub fn from_mut(outer: &mut Outer) -> &mut T[src]

Get a mutable reference to the inner from the outer.

impl<T> MaybeDebug for T where
    T: Debug
[src]

impl<T> MaybeDebug for T where
    T: Debug
[src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<T> SaturatedConversion for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<S, T> UncheckedInto<T> for S where
    T: UncheckedFrom<S>, 
[src]

impl<T, S> UniqueSaturatedInto<T> for S where
    T: Bounded,
    S: TryInto<T>, 
[src]

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]