Struct instance_chart::Chart

source · [−]

pub struct Chart<const N: usize, T: Debug + Clone + Serialize> { /* private fields */ }

Expand description

The chart keeping track of the discoverd nodes. That a node appears in the chart is no guarentee that it is reachable at this moment.

Implementations

source

impl<const N: usize> Chart<N, u16>

source

pub fn addr_lists_vec(&self) -> Vec<[SocketAddr ; N]>

Returns an vector with each discovered node’s socketadresses.

Note

vector order is random
only availible for Chart configured with ChartBuilder::with_service_ports and build using ChartBuilder::finish.

let chart = ChartBuilder::new()
    .with_id(1)
    .with_service_ports([8042, 8043, 8044])
    .finish()?;
let maintain = discovery::maintain(chart.clone());
let _ = tokio::spawn(maintain); // maintain task will run forever
let port_lists = chart.addr_lists_vec();

source

impl<const N: usize> Chart<N, u16>

source

pub fn nth_addr_vec<const IDX: usize>(&self) -> Vec<SocketAddr>

Returns a vector over each discoverd node’s nth-socketadress

Note

vector order is random
only availible for Chart configured with ChartBuilder::with_service_ports and build using ChartBuilder::finish.

Examples

let web_server_port = 8043;
let chart = ChartBuilder::new()
    .with_id(1)
    .with_service_ports([8042, web_server_port, 8044])
    .finish()?;
let maintain = discovery::maintain(chart.clone());
let _ = tokio::spawn(maintain); // maintain task will run forever
let web_server_ports = chart.nth_addr_vec::<2>();

source

impl<'a> Chart<1, u16>

source

pub fn addr_vec(&'a self) -> Vec<SocketAddr>

Returns a vector over each discoverd nodes’s socketadress

Note

vector order is random
only availible for Chart configured with ChartBuilder::with_service_port and build using ChartBuilder::finish.

let chart = ChartBuilder::new()
    .with_id(1)
    .with_service_port(8042)
    .finish()?;
let maintain = discovery::maintain(chart.clone());
let _ = tokio::spawn(maintain); // maintain task will run forever
let ports = chart.addr_vec();

source

impl<const N: usize> Chart<N, u16>

The array of ports set for this chart instance, set in ChartBuilder::with_service_ports.

source

pub fn our_service_ports(&self) -> &[u16 ]

source

impl Chart<1, u16>

The port set for this chart instance, set in ChartBuilder::with_service_port.

source

pub fn our_service_port(&self) -> u16

source

impl<T: Debug + Clone + Serialize> Chart<1, T>

The msg struct for this chart instance, set in ChartBuilder::custom_msg.

source

pub fn our_msg(&self) -> &T

source

impl<const N: usize, T: Debug + Clone + Serialize + DeserializeOwned> Chart<N, T>

source

pub fn notify(&self) -> Notify<N, T>

Wait for new discoveries. Use one of the methods on the notify object to await a new discovery and get the data.

Examples

let chart = ChartBuilder::new()
    .with_id(1)
    .with_service_port(8042)
    .local_discovery(true)
    .finish()?;
let mut node_discoverd = chart.notify();
let maintain = discovery::maintain(chart.clone());
let _ = tokio::spawn(maintain); // maintain task will run forever

while chart.size() < full_size as usize {
    let new = node_discoverd.recv().await.unwrap();
    println!("discoverd new node: {:?}", new);
}