itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-09-27 12:20:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4490 from Brezak/waker-registration-docs

Browse Source 
embassy-sync: Update `MultiWakerRegistration::register` docs
This commit is contained in:
Ulf Lilleengen 2025-08-04 09:17:50 +00:00 committed by GitHub
commit a8cb8a7fe1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
embassy-sync/src/waitqueue/multi_waker.rs
View File

@ -15,7 +15,9 @@ impl<const N: usize> MultiWakerRegistration<N> {
Self { wakers: Vec::new() }
}
/// Register a waker. If the buffer is full the function returns it in the error
/// Register a waker.
///
/// If the buffer is full, [wakes all the wakers](Self::wake), clears its buffer and registers the waker.
pub fn register(&mut self, w: &Waker) {
// If we already have some waker that wakes the same task as `w`, do nothing.
// This avoids cloning wakers, and avoids unnecessary mass-wakes.