Struct Barrier

pub struct Barrier<R = Spin> { /* private fields */ }

A primitive that synchronizes the execution of multiple threads.

Example

use spin;
use std::sync::Arc;
use std::thread;

let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(spin::Barrier::new(10));
for _ in 0..10 {
    let 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();
}

Implementations

impl<R: RelaxStrategy> Barrier<R>

pub fn wait(&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 spin;
use std::sync::Arc;
use std::thread;

let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(spin::Barrier::new(10));
for _ in 0..10 {
    let 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();
}

impl<R> Barrier<R>

pub const 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. A Barrier created with n = 0 will behave identically to one created with n = 1.

Examples

use spin;

let barrier = spin::Barrier::new(10);