Struct hurdles::Barrier

pub struct Barrier { /* private fields */ }

A barrier which enables multiple threads to synchronize the beginning of some computation.

Implementations

impl Barrier

pub fn new(n: usize) -> Self

Creates a new barrier that can block a given number of threads.

A barrier will block n-1 threads which call wait and then wake up all threads at once when the nth thread calls wait.

Examples

use hurdles::Barrier;
let mut barrier = Barrier::new(10);

pub fn wait(&mut self) -> BarrierWaitResult

Blocks the current thread until all threads have rendezvoused here.

Barriers are re-usable after all threads have rendezvoused once, and can be used continuously.

A single (arbitrary) thread will receive a BarrierWaitResult that returns true from is_leader when returning from this function, and all other threads will receive a result that will return false from is_leader.

Examples

use hurdles::Barrier;
use std::thread;

let mut handles = Vec::with_capacity(10);
let mut barrier = Barrier::new(10);
for _ in 0..10 {
    let mut c = barrier.clone();
    // The same messages will be printed together.
    // You will NOT see any interleaving.
    handles.push(thread::spawn(move|| {
        println!("before wait");
        c.wait();
        println!("after wait");
    }));
}
// Wait for other threads to finish.
for handle in handles {
    handle.join().unwrap();
}

Trait Implementations

impl Clone for Barrier

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.