Struct SessionSocketConfig 

pub struct SessionSocketConfig {
    pub frame_size: usize,
    pub frame_timeout: Duration,
    pub max_buffered_segments: usize,
    pub capacity: usize,
    pub flush_immediately: bool,
    pub datagram: bool,
    pub control_channel_capacity: usize,
    pub max_frame_age: Option<Duration>,
    pub max_frames_behind_gap: Option<usize>,
}

Configuration object for SessionSocket.

Fields

frame_size: usize

The maximum size of a frame on the read/write interface of the SessionSocket.

The size is always greater or equal to the MTU C of the underlying transport, and less or equal to:

• (C - SessionMessage::SEGMENT_OVERHEAD) * (SeqIndicator::MAX + 1) for stateless sockets, or
• (C - SessionMessage::SEGMENT_OVERHEAD) * min(SeqIndicator::MAX + 1, SegmentRequest::MAX_MISSING_SEGMENTS_PER_FRAME) for stateful sockets

Default is 1500 bytes.

frame_timeout: Duration

The maximum time to wait for a frame to be fully received.

Default is 800 ms.

max_buffered_segments: usize

Maximum number of segments to buffer in the downstream transport. If 0 is given, the transport is unbuffered.

Default is 0.

capacity: usize

Capacity of the frame reconstructor, the maximum number of incomplete frames, before they are dropped.

Default is 8192.

flush_immediately: bool

Flushes data written to the socket immediately to the underlying transport.

Default is false.

datagram: bool

Preserve datagram boundaries: each write to the socket is emitted as exactly one frame and delivered to the peer as exactly one read, regardless of Self::frame_size. Use for datagram-oriented targets (UDP/WireGuard). Only meaningful on stateless sockets.

Default is false.

control_channel_capacity: usize

Capacity of the control channel, the maximum number of outstanding control messages.

This option affects stateful sockets.

Default is 2048.

max_frame_age: Option<Duration>

Maximum time a fully-received frame may sit in the ordering buffer before being discarded rather than delivered.

Bounds how stale delivered data can be, so a stall surfaces as clean loss instead of a burst of seconds-old frames. Distinct from Self::frame_timeout, which bounds how long a missing frame is waited for. Default None (no bound).

A frame dropped here has already been acknowledged, since the acknowledgement is queued at reassembly. That is deliberate: the ack states that the path delivered the frame, which it did, and the drop is a local freshness policy applied afterwards. Withholding the ack would make the sender retransmit data we discarded precisely for being stale, reintroducing the latency tail this bound exists to remove.

max_frames_behind_gap: Option<usize>

Abandon the frame due next once this many later frames are already waiting behind it, instead of holding them for Self::frame_timeout.

Head-of-line bound. frame_timeout waits for a frame that may still arrive; this bounds how much already-received data is held hostage while that wait runs. On a session without retransmission the missing frame is never coming, so the wait is pure cost: measured on a cluster, 98.5% of bytes returned over the wire while 0.60% reached the application and the application-side inter-arrival median sat exactly on the timeout.

Counting frames rather than watching a clock decides on evidence – a queue building up behind a gap is a lost frame, where one or two frames ahead is ordinary reordering. The right value tracks reordering depth, which is throughput x latency spread, so it is deployment-specific and meant to be tuned. None (default) keeps the previous behaviour.

Trait Implementations

impl Clone for SessionSocketConfig

fn clone(&self) -> SessionSocketConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SessionSocketConfig

impl Debug for SessionSocketConfig

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

Formats the value using the given formatter.

impl Default for SessionSocketConfig

fn default() -> Self

Return SessionSocketConfig { frame_size: 1500, frame_timeout: Duration::from_millis(800), max_buffered_segments: 0, capacity: 8192, flush_immediately: false, datagram: false, control_channel_capacity: 2048, max_frame_age: None, max_frames_behind_gap: None }

impl Eq for SessionSocketConfig

impl PartialEq for SessionSocketConfig

fn eq(&self, other: &SessionSocketConfig) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SessionSocketConfig