nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-22 14:53:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2660 from embassy-rs/zerocopy-docs

Browse Source 
docs: clarify capabilities of zerocopy channel
This commit is contained in:
Dario Nieuwenhuis 2024-03-04 17:52:03 +00:00 committed by GitHub
commit 60567b72fb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
embassy-sync/src/zerocopy_channel.rs
View File

@ -1,10 +1,7 @@
//! A zero-copy queue for sending values between asynchronous tasks. //! A zero-copy queue for sending values between asynchronous tasks.
//! //!
//! It can be used concurrently by multiple producers (senders) and multiple //! It can be used concurrently by a producer (sender) and a
//! consumers (receivers), i.e. it is an "MPMC channel". //! consumer (receiver), i.e. it is an "SPSC channel".
//!
//! Receivers are competing for messages. So a message that is received by
//! one receiver is not received by any other.
//! //!
//! This queue takes a Mutex type so that various //! This queue takes a Mutex type so that various
//! targets can be attained. For example, a ThreadModeMutex can be used //! targets can be attained. For example, a ThreadModeMutex can be used