Struct NodeConfig 

#[non_exhaustive]
pub struct NodeConfig {
    pub should_connect: bool,
    pub is_gateway: bool,
    pub key_pair: TransportKeypair,
    pub network_listener_ip: IpAddr,
    pub network_listener_port: u16,
    /* private fields */
}

When instancing a node you can either join an existing network or bootstrap a new network with a listener which will act as the initial provider. This initial peer will be listening at the provided port and assigned IP. If those are not free the instancing process will return an error.

In order to bootstrap a new network the following arguments are required to be provided to the builder:

• ip: IP associated to the initial node.
• port: listening port of the initial node.

If both are provided but also additional peers are added via the Self::add_gateway() method, this node will be listening but also try to connect to an existing peer.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

should_connect: bool

Determines if an initial connection should be attempted. Only true for an initial gateway/node. If false, the gateway will be disconnected unless other peers connect through it.

is_gateway: bool

key_pair: TransportKeypair

If not specified, a key is generated and used when creating the node.

network_listener_ip: IpAddr

IP to bind to the network listener.

network_listener_port: u16

socket port to bind to the network listener.

Implementations

impl NodeConfig

pub async fn new(config: Config) -> Result<NodeConfig>

pub fn config(&self) -> &Config

pub fn is_gateway(&mut self) -> &mut Self

pub fn first_gateway(&mut self)

pub fn with_should_connect(&mut self, should_connect: bool) -> &mut Self

pub fn max_hops_to_live(&mut self, num_hops: usize) -> &mut Self

pub fn rnd_if_htl_above(&mut self, num_hops: usize) -> &mut Self

pub fn max_number_of_connections(&mut self, num: usize) -> &mut Self

pub fn min_number_of_connections(&mut self, num: usize) -> &mut Self

pub fn with_own_addr(&mut self, addr: SocketAddr) -> &mut Self

pub fn with_location(&mut self, loc: Location) -> &mut Self

pub fn add_gateway(&mut self, peer: InitPeerNode) -> &mut Self

Connection info for an already existing peer. Required in case this is not a gateway node.

pub async fn build<const CLIENTS: usize>( self, clients: [Box<dyn ClientEventsProxy + Send + 'static>; CLIENTS], ) -> Result<Node>

Builds a node using the default backend connection manager.

pub async fn build_with_flush_handle<const CLIENTS: usize>( self, clients: [Box<dyn ClientEventsProxy + Send + 'static>; CLIENTS], ) -> Result<(Node, EventFlushHandle)>

Builds a node and returns flush handle for event aggregation (for testing).

pub fn get_own_addr(&self) -> Option<SocketAddr>

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a duplicate 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<'de> Deserialize<'de> for NodeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NodeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.