Struct Stream

pub struct Stream {

    pub initial_sequence_number: u32,
    pub seq_offset: SeqOffset,
    pub window_scale: u8,
    pub got_window_scale: bool,
    pub state: StreamInboundState,
    pub seq_window_start: u32,
    pub seq_window_end: u32,
    pub highest_acked: u64,
    pub reverse_acked: u64,
    pub had_reset: bool,
    pub has_ended: bool,
    pub gaps_length: u64,
    pub retransmit_count: usize,
    pub segments_info: BinaryHeap<SegmentInfo>,
    pub segments_info_dropped: usize,
}

unidirectional stream of a connection

Fields

initial_sequence_number: u32

initial sequence number

seq_offset: SeqOffset

offset from packet sequence number to absolute stream offset

window_scale: u8

window scale

got_window_scale: bool

if the window scale was captured (if not, try to estimate)

state: StreamInboundState

stream state

seq_window_start: u32

lowest acceptable TCP sequence number (used to disambiguate absolute offset)

seq_window_end: u32

highest acceptable TCP sequence number plus one

highest_acked: u64

highest offset at which we have received an ack

reverse_acked: u64

highest acked offset of opposite stream

had_reset: bool

whether a reset happened in this direction

has_ended: bool

true if the FIN for this stream was acked

gaps_length: u64

count of bytes skipped due to gaps

retransmit_count: usize

detected retransmission count

segments_info: BinaryHeap<SegmentInfo>

segment metadata

segments_info_dropped: usize

number of packets not written to segments_info because it was full

Implementations

impl Stream

pub fn new() -> Self

create new instance

pub fn readable_buffered_length(&self) -> usize

return the number of bytes currently buffered and readable

pub fn total_buffered_length(&self) -> usize

return the total length of the buffer, including segments not yet readable

pub fn buffer_start(&self) -> u64

get offset of head of internal buffer

pub fn set_window_scale(&mut self, window_scale: u8) -> bool

set the window scale option

pub fn estimate_window_scale(&mut self, fit_end_offset: u64) -> bool

if window scale was not received, try to estimate it

pub fn set_isn(&mut self, isn: u32, window_size: u16)

set initial sequence number

pub fn update_offset( &mut self, number: u32, should_advance: bool, ) -> Option<u64>

update seq_window and seq_offset based on current window, return whether the value was in the current window and the absolute stream offset

pub fn handle_data_packet( &mut self, sequence_number: u32, data: &[u8], extra: &PacketExtra, ) -> bool

handle data packet in the forward direction

pub fn handle_ack_packet( &mut self, acknowledgment_number: u32, window_size: u16, extra: &PacketExtra, ) -> bool

handle ack packet in the reverse direction

pub fn handle_fin_packet( &mut self, sequence_number: u32, data_len: usize, extra: &PacketExtra, ) -> bool

handle FIN packet

pub fn handle_rst_packet( &mut self, sequence_number: u32, extra: &PacketExtra, ) -> bool

handle reset packet in established state

pub fn add_segment_info(&mut self, info: SegmentInfo) -> bool

add an info object to segments_info

pub fn read_segments_until( &mut self, end_offset: Option<u64>, in_segments: &mut Vec<SegmentInfo>, )

pop and read segment info until offset, adding to vec. if end_offset is None, read everything

pub fn read_gaps(&mut self, range: Range<u64>, in_gaps: &mut Vec<Range<u64>>)

read gaps in buffer in a given range, adding to vec and accounting in gaps_length

pub fn read_next<T>( &mut self, end_offset: u64, in_segments: &mut Vec<SegmentInfo>, in_gaps: &mut Vec<Range<u64>>, read_fn: impl FnOnce(RingBufSlice<'_, u8>) -> T, ) -> Option<T>

read state until offset

Trait Implementations

impl Default for Stream

fn default() -> Self

Returns the “default value” for a type.