PendingAck

Struct PendingAck 

Source
pub struct PendingAck<const FRAME: usize = MAX_RESEND_FRAME_LEN> {
    pub ack_trailer: [u8; 8],
    pub peer: PublicKey,
    pub resend: ResendRecord<FRAME>,
    pub sent_ms: u64,
    pub ack_deadline_ms: u64,
    pub retries: u8,
    pub state: AckState,
    pub completion: CompletionSignal,
    pub confirm_key: Option<DupCacheKey>,
}
Expand description

Complete tracking state for one in-flight tracked transmission.

The coordinator’s IdentitySlot maintains a LinearMap of PendingAck records keyed by SendReceipt, one per active tracked send — every ACK-requested send, plus every non-ACK unicast or blind unicast that travels through repeaters and therefore retries until a repeat is heard (CompletionSignal). The record holds everything needed to detect completion, detect timeout, and retransmit:

  • ack_trailer — the 8-byte ack_mic || ack_tag value that will appear as the destination’s MAC ACK trailer. The ack_mic half correlates the ack to this request; the keyed ack_tag half can only be produced by a node that received and successfully decrypted the original frame, so a matching trailer is cryptographic proof of delivery.
  • peer — the destination’s full public key, used to look up the correct pending entry when matching an inbound MAC ACK against the pending table.
  • resend — a verbatim copy of the sealed frame for retransmission. See ResendRecord.
  • sent_ms — the monotonic millisecond timestamp at which the frame was first transmitted; useful for latency measurement.
  • ack_deadline_ms — absolute deadline for the final ACK. Expiry means failure and the entry is removed.
  • retries — the number of retransmissions already attempted; capped at MAX_FORWARD_RETRIES.
  • state — current position in the AckState lifecycle (forwarding confirmation wait or final-ACK wait).

Use PendingAck::direct for sends to nodes in direct radio range, PendingAck::forwarded when routing through a repeater, or PendingAck::repeat_only for a non-ACK send that completes on an overheard repeat.

Fields§

§ack_trailer: [u8; 8]

Expected 8-byte MAC ack trailer (ack_mic || ack_tag) used for inbound matching. Never matched for CompletionSignal::RepeatOnly entries.

§peer: PublicKey

Final destination peer.

§resend: ResendRecord<FRAME>

Retransmission data.

§sent_ms: u64

Initial send timestamp in milliseconds.

§ack_deadline_ms: u64

Absolute deadline for the final ACK — or, for a CompletionSignal::RepeatOnly entry, the terminal deadline after which the entry is silently discarded.

§retries: u8

Number of retries already attempted.

§state: AckState

Current state in the ACK lifecycle.

§completion: CompletionSignal

Which observation completes this send.

§confirm_key: Option<DupCacheKey>

Routing identity of the transmitted frame, recorded at transmit time so an overheard repeat can be matched against this entry even after the post-transmit listen window has lapsed.

Implementations§

Source§

impl<const FRAME: usize> PendingAck<FRAME>

Source

pub fn direct( ack_trailer: [u8; 8], peer: PublicKey, resend: ResendRecord<FRAME>, ) -> Self

Create pending-ACK state for a direct send.

Source

pub fn forwarded( ack_trailer: [u8; 8], peer: PublicKey, resend: ResendRecord<FRAME>, ) -> Self

Create pending-ACK state for a forwarded send.

Source

pub fn repeat_only(peer: PublicKey, resend: ResendRecord<FRAME>) -> Self

Create tracking state for a non-ACK send that completes when a repeat of the frame is overheard.

Source

pub fn expects_ack(&self) -> bool

Whether a transport ACK is expected for this entry.

Trait Implementations§

Source§

impl<const FRAME: usize> Clone for PendingAck<FRAME>

Source§

fn clone(&self) -> PendingAck<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 FRAME: usize> Debug for PendingAck<FRAME>

Source§

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

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

impl<const FRAME: usize> PartialEq for PendingAck<FRAME>

Source§

fn eq(&self, other: &PendingAck<FRAME>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const FRAME: usize> Eq for PendingAck<FRAME>

Source§

impl<const FRAME: usize> StructuralPartialEq for PendingAck<FRAME>

Auto Trait Implementations§

§

impl<const FRAME: usize> Freeze for PendingAck<FRAME>

§

impl<const FRAME: usize> RefUnwindSafe for PendingAck<FRAME>

§

impl<const FRAME: usize> Send for PendingAck<FRAME>

§

impl<const FRAME: usize> Sync for PendingAck<FRAME>

§

impl<const FRAME: usize> Unpin for PendingAck<FRAME>

§

impl<const FRAME: usize> UnwindSafe for PendingAck<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.