TxQueue

Struct TxQueue 

Source
pub struct TxQueue<const N: usize = 16, const FRAME: usize = MAX_RESEND_FRAME_LEN> { /* private fields */ }
Expand description

Fixed-capacity, priority-ordered transmit queue owned by the Mac coordinator.

The TxQueue serializes all outgoing frames — MAC ACKs, forwarded frames, retransmissions, and application sends — into a single ordered sequence for delivery to the radio one at a time. Entries are serviced in TxPriority order, with FIFO ordering within each class.

The queue capacity N is a compile-time constant (default DEFAULT_TX). Attempts to enqueue beyond capacity fail with crate::CapacityError, propagated as SendError::QueueFull or MacError::QueueFull. Choose N large enough to absorb the worst-case burst: a forwarded frame, its MAC ACK, plus any application sends already queued, plus the retransmit backlog.

Internally the queue is an unsorted heapless::Vec<QueuedTx, N>. The dequeue operation does a linear scan for the highest-priority, lowest-sequence entry whose not_before_ms has elapsed, which is O(N) — acceptable for the small N typical in embedded deployments.

Implementations§

Source§

impl<const N: usize, const FRAME: usize> TxQueue<N, FRAME>

Source

pub fn new() -> Self

Create an empty transmission queue.

Source

pub fn len(&self) -> usize

Return the number of queued transmissions.

Source

pub fn is_empty(&self) -> bool

Return whether no transmissions are queued.

Source

pub fn enqueue( &mut self, priority: TxPriority, frame: &[u8], receipt: Option<SendReceipt>, identity_id: Option<LocalIdentityId>, ) -> Result<u32, CapacityError>

Enqueue a frame and return its internal sequence number.

Source

pub fn enqueue_with_state( &mut self, priority: TxPriority, frame: &[u8], receipt: Option<SendReceipt>, identity_id: Option<LocalIdentityId>, not_before_ms: u64, cad_attempts: u8, forward_deferrals: u8, ) -> Result<u32, CapacityError>

Enqueue a frame with explicit timer and CAD state.

Source

pub fn pop_next(&mut self) -> Option<QueuedTx<FRAME>>

Remove and return the highest-priority queued frame.

Source

pub fn earliest_not_before_ms(&self) -> Option<u64>

Return the earliest not_before_ms across all entries, if any are deferred.

Source

pub fn has_ready(&self, now_ms: u64) -> bool

Return whether the queue contains any entry that is ready to send now.

Source

pub fn remove_first_matching( &mut self, predicate: impl FnMut(&QueuedTx<FRAME>) -> bool, ) -> Option<QueuedTx<FRAME>>

Remove and return the first queued frame matching predicate.

Trait Implementations§

Source§

impl<const N: usize, const FRAME: usize> Clone for TxQueue<N, FRAME>

Source§

fn clone(&self) -> TxQueue<N, FRAME>

Returns a duplicate of the value. Read more
1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const N: usize, const FRAME: usize> Debug for TxQueue<N, FRAME>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<const N: usize, const FRAME: usize> Default for TxQueue<N, FRAME>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<const N: usize, const FRAME: usize> Freeze for TxQueue<N, FRAME>

§

impl<const N: usize, const FRAME: usize> RefUnwindSafe for TxQueue<N, FRAME>

§

impl<const N: usize, const FRAME: usize> Send for TxQueue<N, FRAME>

§

impl<const N: usize, const FRAME: usize> Sync for TxQueue<N, FRAME>

§

impl<const N: usize, const FRAME: usize> Unpin for TxQueue<N, FRAME>

§

impl<const N: usize, const FRAME: usize> UnwindSafe for TxQueue<N, FRAME>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.