Skip to main content

CallerHandshake

Struct CallerHandshake 

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

A driveable Caller-side SRT handshake (draft-sharabayko-srt-01 §4.3.1).

Implementations§

Source§

impl CallerHandshake

Source

pub fn new(own_socket_id: u32, config: HandshakeConfig) -> Self

Creates a fresh Caller handshake in CallerHandshakeState::Idle.

Source

pub fn state(&self) -> CallerHandshakeState

The current state.

Source

pub fn negotiated(&self) -> Option<&NegotiatedParams>

The negotiated parameters, once CallerHandshakeState::Connected.

Source

pub fn start(&mut self) -> Result<Vec<u8>>

Builds the initial INDUCTION handshake (§4.3.1.1) and transitions to CallerHandshakeState::AwaitingInductionResponse.

§Errors

Error::HandshakeOutOfSequence if called more than once.

Source

pub fn feed( &mut self, packet: &ControlPacket<'_>, ) -> Result<Vec<HandshakeOutput>>

Feeds an inbound control packet. Only meaningful while awaiting the Listener’s INDUCTION or CONCLUSION response.

§Errors

Error::UnexpectedControlPacket if packet is not a Handshake packet; Error::HandshakeOutOfSequence if fed outside those two states (a driver bug, not a peer failure).

Source

pub fn feed_bytes(&mut self, bytes: &[u8]) -> Result<Vec<HandshakeOutput>>

Convenience wrapper: parses bytes as an ControlPacket then Self::feeds it.

Source

pub fn tick(&mut self) -> Vec<HandshakeOutput>

Advances retransmit timing by one caller-defined tick. If the handshake is waiting on a peer response and HandshakeConfig::retransmit_after_ticks have elapsed with none arriving, re-emits the last sent packet; after HandshakeConfig::max_retries such retransmissions, transitions to CallerHandshakeState::TimedOut.

Trait Implementations§

Source§

impl Debug for CallerHandshake

Source§

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

Formats the value using the given formatter. Read more

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, 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.