diff options
| author | Dario Nieuwenhuis <[email protected]> | 2024-03-04 17:52:03 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-03-04 17:52:03 +0000 |
| commit | 60567b72fb8807bf72aa28f0e2c551953c1ef7bf (patch) | |
| tree | 1944bc9238b4ed9004874229f415a3ca5d2473d6 /embassy-sync/src | |
| parent | 49807c0e7f166e44791d621c503ad771325c37b1 (diff) | |
| parent | 2a257573773f3dabdf16ea6a44ba0dadef786f37 (diff) | |
Merge pull request #2660 from embassy-rs/zerocopy-docs
docs: clarify capabilities of zerocopy channel
Diffstat (limited to 'embassy-sync/src')
| -rw-r--r-- | embassy-sync/src/zerocopy_channel.rs | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/embassy-sync/src/zerocopy_channel.rs b/embassy-sync/src/zerocopy_channel.rs index f704cbd5d..cfce9a571 100644 --- a/embassy-sync/src/zerocopy_channel.rs +++ b/embassy-sync/src/zerocopy_channel.rs | |||
| @@ -1,10 +1,7 @@ | |||
| 1 | //! A zero-copy queue for sending values between asynchronous tasks. | 1 | //! A zero-copy queue for sending values between asynchronous tasks. |
| 2 | //! | 2 | //! |
| 3 | //! It can be used concurrently by multiple producers (senders) and multiple | 3 | //! It can be used concurrently by a producer (sender) and a |
| 4 | //! consumers (receivers), i.e. it is an "MPMC channel". | 4 | //! consumer (receiver), i.e. it is an "SPSC channel". |
| 5 | //! | ||
| 6 | //! Receivers are competing for messages. So a message that is received by | ||
| 7 | //! one receiver is not received by any other. | ||
| 8 | //! | 5 | //! |
| 9 | //! This queue takes a Mutex type so that various | 6 | //! This queue takes a Mutex type so that various |
| 10 | //! targets can be attained. For example, a ThreadModeMutex can be used | 7 | //! targets can be attained. For example, a ThreadModeMutex can be used |