aboutsummaryrefslogtreecommitdiff
path: root/rtic-time/src/linked_list.rs
diff options
context:
space:
mode:
Diffstat (limited to 'rtic-time/src/linked_list.rs')
-rw-r--r--rtic-time/src/linked_list.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/rtic-time/src/linked_list.rs b/rtic-time/src/linked_list.rs
index c2a9967..b84b92d 100644
--- a/rtic-time/src/linked_list.rs
+++ b/rtic-time/src/linked_list.rs
@@ -1,11 +1,12 @@
-//! ...
-
use core::marker::PhantomPinned;
use core::pin::Pin;
use core::sync::atomic::{AtomicPtr, Ordering};
use critical_section as cs;
-/// A sorted linked list for the timer queue.
+/// An atomic sorted linked list for the timer queue.
+///
+/// Atomicity is guaranteed using very short [`critical_section`]s, so this list is _not_
+/// lock free, but it will not deadlock.
pub(crate) struct LinkedList<T> {
head: AtomicPtr<Link<T>>,
}