summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDion Dokter <diondokter@gmail.com>2022-06-03 14:27:33 +0200
committerGitHub <noreply@github.com>2022-06-03 14:27:33 +0200
commit9efaae495b1f5495c5356bed73e176877b03b7ff (patch)
tree8a000f424c8141ea20f44eb3c1421f34888762c2
parent9d5af531e35ce0e88afd0100a5b48b5de28a4f90 (diff)
downloadembassy-9efaae495b1f5495c5356bed73e176877b03b7ff.zip
Channel clarification
This was unclear from the docs.
-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 a1d805c5..d74f6365 100644
--- a/embassy/src/channel/channel.rs
+++ b/embassy/src/channel/channel.rs
@@ -3,6 +3,9 @@
//! 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.
+//!
//! This queue takes a Mutex type so that various
//! targets can be attained. For example, a ThreadModeMutex can be used
//! for single-core Cortex-M targets where messages are only passed