https://github.com/sunsided/rendezvous-rs
Easier rendezvous channels for thread synchronization
https://github.com/sunsided/rendezvous-rs
rendezvous rust thread thread-synchronization
Last synced: 4 months ago
JSON representation
Easier rendezvous channels for thread synchronization
- Host: GitHub
- URL: https://github.com/sunsided/rendezvous-rs
- Owner: sunsided
- License: eupl-1.2
- Created: 2023-12-01T17:21:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T13:19:20.000Z (about 1 year ago)
- Last Synced: 2025-01-25T14:20:52.621Z (about 1 year ago)
- Topics: rendezvous, rust, thread, thread-synchronization
- Language: Rust
- Homepage: https://crates.io/crates/rendezvous
- Size: 41 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Easier Rendezvous Channels
In rust, [mpsc::channel](https://doc.rust-lang.org/std/sync/mpsc/fn.channel.html) can be used as a synchronization
primitive between threads by utilizing the fact that we can block on the receiver's `recv()` function until all senders
are dropped.
This crate aims at giving the concept an expressive name and at reducing some classes of race conditions, namely those
where the original sender was not dropped before the call to `recv()`.
This version of the crate only supports synchronous code due to the dropping semantics.
```shell
cargo add rendezvous
```
## Example usage
```rust
use std::sync::{Arc, Mutex};
use std::thread;
use std::time::Duration;
use rendezvous::{Rendezvous, RendezvousGuard};
/// A slow worker function. Sleeps, then mutates a value.
fn slow_worker_fn(_guard: RendezvousGuard, mut value: Arc>) {
thread::sleep(Duration::from_millis(400));
let mut value = value.lock().unwrap();
*value = 42;
}
fn example() {
// The guard that ensures synchronization across threads.
// Rendezvous itself acts as a guard: If not explicitly dropped, it will block the current
// scope until all rendezvous points are reached.
let rendezvous = Rendezvous::new();
// A value to mutate in a different thread.
let value = Arc::new(Mutex::new(0u32));
// Run the worker in a thread.
thread::spawn({
let guard = rendezvous.fork_guard();
let value = value.clone();
move || slow_worker_fn(guard, value)
});
// Block until the thread has finished its work.
rendezvous.rendezvous();
// The thread finished in time.
assert_eq!(*(value.lock().unwrap()), 42);
}
```