max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Scott Mabin
2023-11-18 15:08:16 +00:00
parent f482a105b8
commit 5a60024af7
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
embassy-sync/README.md
View File

@@ -5,6 +5,7 @@ An [Embassy](https://embassy.dev) project.
Synchronization primitives and data structures with async support: Synchronization primitives and data structures with async support:
- [`Channel`](channel::Channel) - A Multiple Producer Multiple Consumer (MPMC) channel. Each message is only received by a single consumer. - [`Channel`](channel::Channel) - A Multiple Producer Multiple Consumer (MPMC) channel. Each message is only received by a single consumer.
- [`PriorityChannel`](channel::priority::PriorityChannel) - A Multiple Producer Multiple Consumer (MPMC) channel. Each message is only received by a single consumer. Higher priority items are sifted to the front of the channel.
- [`PubSubChannel`](pubsub::PubSubChannel) - A broadcast channel (publish-subscribe) channel. Each message is received by all consumers. - [`PubSubChannel`](pubsub::PubSubChannel) - A broadcast channel (publish-subscribe) channel. Each message is received by all consumers.
- [`Signal`](signal::Signal) - Signalling latest value to a single consumer. - [`Signal`](signal::Signal) - Signalling latest value to a single consumer.
- [`Mutex`](mutex::Mutex) - Mutex for synchronizing state between asynchronous tasks. - [`Mutex`](mutex::Mutex) - Mutex for synchronizing state between asynchronous tasks.

6
embassy-sync/src/channel/priority.rs
View File

@@ -323,7 +323,9 @@ where
/// buffer is full, attempts to `send` new messages will wait until a message is /// buffer is full, attempts to `send` new messages will wait until a message is
/// received from the channel. /// received from the channel.
/// ///
/// All data sent will become available in the same order as it was sent. /// Sent data may be reordered based on their priorty within the channel.
/// For example, in a [`Max`](heapless::binary_heap::Max) [`PriorityChannel`]
/// containing `u32`'s, data sent in the following order `[1, 2, 3]` will be recieved as `[3, 2, 1]`.
pub struct PriorityChannel<M, T, K, const N: usize> pub struct PriorityChannel<M, T, K, const N: usize>
where where
T: Ord, T: Ord,
@@ -509,8 +511,10 @@ mod tests {
// Prio channel with kind `Max` sifts larger numbers to the front of the queue // Prio channel with kind `Max` sifts larger numbers to the front of the queue
let mut c = ChannelState::<u32, Max, 3>::new(); let mut c = ChannelState::<u32, Max, 3>::new();
assert!(c.try_send(1).is_ok()); assert!(c.try_send(1).is_ok());
assert!(c.try_send(2).is_ok());
assert!(c.try_send(3).is_ok()); assert!(c.try_send(3).is_ok());
assert_eq!(c.try_receive().unwrap(), 3); assert_eq!(c.try_receive().unwrap(), 3);
assert_eq!(c.try_receive().unwrap(), 2);
assert_eq!(c.try_receive().unwrap(), 1); assert_eq!(c.try_receive().unwrap(), 1);
} }