NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: clarify capabilities of zerocopy channel

Browse source
This commit is contained in:
Ulf Lilleengen 2024-03-04 18:36:34 +01:00
parent 4c7ed5e055
commit 2a25757377
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.
//!
//! It can be used concurrently by multiple producers (senders) and multiple
//! consumers (receivers), i.e. it is an "MPMC channel".
//!
//! Receivers are competing for messages. So a message that is received by
//! one receiver is not received by any other.
//! It can be used concurrently by a producer (sender) and a
//! consumer (receiver), i.e. it is an "SPSC channel".
//!
//! This queue takes a Mutex type so that various
//! targets can be attained. For example, a ThreadModeMutex can be used