Struct Notify

pub struct Notify<const N: usize, T: Debug + Clone>(/* private fields */);

Wait for notifications of new discoveries, buffering up to 256 discoveries, created using Chart::notify().

Examples

   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);
   }
}

Implementations

impl<T: Debug + Clone> Notify<1, T>

pub async fn recv_one(&mut self) -> Result<(Id, IpAddr, T), RecvError>

await the next discovered instance. Returns the id and custom messag for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::custom_msg()

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

impl<const N: usize, T: Debug + Clone> Notify<N, T>

pub async fn recv(&mut self) -> Result<(Id, IpAddr, [T; N]), RecvError>

await the next discovered instance. Returns the id and custom messages for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::custom_msg()

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

pub async fn recv_nth<const IDX: usize>( &mut self, ) -> Result<(Id, IpAddr, T), RecvError>

await the next discovered instance. Returns the id and nth custom messages for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::custom_msg()

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

impl Notify<1, u16>

pub async fn recv_addr(&mut self) -> Result<(Id, SocketAddr), RecvError>

await the next discovered instance. Returns the id and service adresses for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::finish() that had as single service port set.

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

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

pub async fn recv_addresses( &mut self, ) -> Result<(Id, [SocketAddr; N]), RecvError>

await the next discovered instance. Buffers up to 256 discoveries. Returns the id and service adresseses for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::finish() that had multiple service ports set.

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

pub async fn recv_nth_addr<const IDX: usize>( &mut self, ) -> Result<(Id, SocketAddr), RecvError>

await the next discovered instance. Buffers up to 256 discoveries. Returns the id and nth service adresses for new node when it is discovered.

Note

Can only be called on a Notify for a chart created with ChartBuilder::finish() that had multiple service ports set.

Errors

If more the 256 discoveries have been made since this was called this returns RecvError::Lagged

Trait Implementations

impl<const N: usize, T: Debug + Debug + Clone> Debug for Notify<N, T>

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

Formats the value using the given formatter.