aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2022-06-03 12:31:40 +0000
committerGitHub <[email protected]>2022-06-03 12:31:40 +0000
commit34673f52c9c23179f0274726a5aa1877dd554df0 (patch)
tree8a000f424c8141ea20f44eb3c1421f34888762c2
parent9d5af531e35ce0e88afd0100a5b48b5de28a4f90 (diff)
parent9efaae495b1f5495c5356bed73e176877b03b7ff (diff)
Merge #791
791: Channel clarification r=lulf a=diondokter This was unclear from the docs. Co-authored-by: Dion Dokter <[email protected]>
-rw-r--r--embassy/src/channel/channel.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/embassy/src/channel/channel.rs b/embassy/src/channel/channel.rs
index a1d805c53..d74f6365d 100644
--- a/embassy/src/channel/channel.rs
+++ b/embassy/src/channel/channel.rs
@@ -3,6 +3,9 @@
3//! It can be used concurrently by multiple producers (senders) and multiple 3//! It can be used concurrently by multiple producers (senders) and multiple
4//! consumers (receivers), i.e. it is an "MPMC channel". 4//! consumers (receivers), i.e. it is an "MPMC channel".
5//! 5//!
6//! Receivers are competing for messages. So a message that is received by
7//! one receiver is not received by any other.
8//!
6//! This queue takes a Mutex type so that various 9//! This queue takes a Mutex type so that various
7//! targets can be attained. For example, a ThreadModeMutex can be used 10//! targets can be attained. For example, a ThreadModeMutex can be used
8//! for single-core Cortex-M targets where messages are only passed 11//! for single-core Cortex-M targets where messages are only passed