Skip to main content

ReliableStream

Struct ReliableStream 

Source
pub struct ReliableStream { /* private fields */ }
Expand description

Reliable stream mode with selective NACKs.

Features:

  • Bounded retransmit window (32 packets)
  • Selective NACKs (receiver-driven)
  • Per-stream state
  • Configurable RTO

Suitable for:

  • Tool call results
  • Guardrail decisions
  • Session lifecycle events
  • Error propagation

Implementations§

Source§

impl ReliableStream

Source

pub const DEFAULT_RTO: Duration

Default retransmit timeout

Source

pub const DEFAULT_MAX_PENDING: usize = 32

Default max pending packets

Source

pub const DEFAULT_MAX_RETRIES: u8 = 3

Default max retries

Source

pub fn new() -> Self

Create a new reliable stream with default settings

Source

pub fn with_settings(rto: Duration, max_pending: usize, max_retries: u8) -> Self

Create with custom settings

Source

pub fn untracked_evictions(&self) -> u64

Number of unacknowledged packets that the stream evicted from its retransmit window because the window was full at on_send time. Each eviction means the caller’s syscall succeeded (bytes left this node) but the packet is no longer tracked for retransmit — a NACK can no longer recover it. A non-zero value indicates max_pending is undersized for the stream’s sustained throughput. Operators should size up or apply upstream backpressure rather than accepting silent loss.

Source

pub fn set_rto(&mut self, rto: Duration)

Set the retransmit timeout

Source

pub fn next_expected(&self) -> u64

Lowest sequence number we have not yet received. All sequences strictly below this value are contiguously received.

Source

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

Highest contiguously-received sequence number, or None if no packets have been received yet.

Source

pub fn ack_seq(&self) -> u64

Get the current ack sequence (highest contiguously-received seq). Returns 0 when nothing has been received yet — callers that need to distinguish “received seq 0” from “received nothing” should use Self::last_received_contiguous instead.

Source

pub fn on_ack(&mut self, acked: u64)

Process an acknowledgment. acked is the highest sequence the peer has contiguously received.

Trait Implementations§

Source§

impl Debug for ReliableStream

Source§

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

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

impl Default for ReliableStream

Source§

fn default() -> Self

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

impl ReliabilityMode for ReliableStream

Source§

fn on_send(&mut self, descriptor: Arc<RetransmitDescriptor>)

Called when a packet is sent. The descriptor carries pre- encryption inputs so the retransmit path can rebuild a fresh-counter packet rather than replaying stale ciphertext.
Source§

fn on_receive(&mut self, seq: u64) -> bool

Called when a packet is received. Returns true if accepted.
Source§

fn needs_ack(&self) -> bool

Check if this mode requires acknowledgments
Source§

fn build_nack(&self) -> Option<NackPayload>

Build a NACK payload if there are missing sequences
Source§

fn on_nack(&mut self, nack: &NackPayload) -> Vec<Arc<RetransmitDescriptor>>

Process a received NACK and return descriptors for the caller to rebuild + dispatch. The returned Arc clones share the inner RetransmitDescriptor allocation; the caller bumps the refcount instead of deep-cloning the Vec<Bytes> of events.
Source§

fn get_timed_out(&mut self) -> Vec<Arc<RetransmitDescriptor>>

Get descriptors that need retransmission due to timeout. See Self::on_nack for the Arc-sharing contract.
Source§

fn has_pending(&self) -> bool

Check if there are unacknowledged packets
Source§

fn name(&self) -> &'static str

Get the name of this reliability mode

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

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
Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more