Struct SessionTelemetry 

pub struct SessionTelemetry { /* private fields */ }

Internal metrics tracker for a session.

This struct uses atomic counters to allow lock-free updates from multiple threads/tasks.

Implementations

impl SessionTelemetry

pub fn new(session_id: SessionId, cfg: HoprSessionConfig) -> Self

pub fn session_id(&self) -> &SessionId

Returns a reference to the session ID.

pub fn set_state(&self, state: SessionLifecycleState)

Updates the session lifecycle state.

This method atomically stores the new state, which affects the metrics snapshot and indicates the session’s current phase (Active, Closing, or Closed).

pub fn touch_activity(&self)

Records activity on the session by updating the last activity timestamp.

This is called on read/write operations to track session idleness.

pub fn record_read(&self, bytes: usize)

Records an incoming read operation with the specified number of bytes.

Increments byte and packet counters, and updates activity timestamp. Zero-byte reads are ignored.

pub fn record_write(&self, bytes: usize)

Records an outgoing write operation with the specified number of bytes.

Increments byte and packet counters, and updates activity timestamp. Zero-byte writes are ignored.

pub fn set_refill_in_flight(&self, active: bool)

Sets whether a SURB (Single Use Reply Block) refill request is currently in flight.

pub fn set_inspector(&self, inspector: FrameInspector)

Sets the frame inspector for tracking incomplete frames.

The inspector is initialized only once via OnceLock.

pub fn set_surb_estimator( &self, estimator: AtomicSurbFlowEstimator, target_buffer: u64, )

Sets the SURB flow estimator for tracking produced/consumed SURBs.

The estimator and target buffer are initialized only once via OnceLock.

pub fn snapshot(&self) -> SessionStatsSnapshot

Creates a snapshot of all current metrics.

This method atomically reads all metric counters and creates an immutable snapshot that includes lifetime, frame buffer, acknowledgement, SURB, and transport metrics. SURB metrics are loaded automatically from the stored estimator if one was set via [set_surb_estimator].

Trait Implementations

impl Debug for SessionTelemetry

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

Formats the value using the given formatter.

impl SessionTelemetryTracker for SessionTelemetry

fn frame_emitted(&self)

Records a frame that has been emitted from the Sequencer.

fn frame_completed(&self)

Records a frame that has successfully reassembled by the Reassembler.

fn frame_discarded(&self)

Records a frame that has been discarded due to timeout or other errors.

fn incomplete_frame(&self)

Records an incomplete frame that could not be reassembled.

fn incoming_message(&self, msg: SessionMessageDiscriminants)

Records an incoming Session message.

fn outgoing_message(&self, msg: SessionMessageDiscriminants)

Records an outgoing Session message.

fn error(&self)

Records an error that occurred during processing of a Session packet.