Skip to main content

RendezvousHandshake

Struct RendezvousHandshake 

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

A driveable, symmetric SRT Rendezvous handshake (draft-sharabayko-srt-01 §4.3.2). See the module docs for the state machine and the design decisions not explicit in the curated rules.

Implementations§

Source§

impl RendezvousHandshake

Source

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

Creates a fresh Rendezvous handshake in RendezvousHandshakeState::Idle, with the 32-bit cookie this side will offer in the cookie contest (§4.3.2, L2107-2135). This crate never reads a clock or a socket address — see crate::handshake_sm::derive_cookie for a ready-made, non-standardized derivation helper.

Source

pub fn state(&self) -> RendezvousHandshakeState

The current state.

Source

pub fn role(&self) -> Option<RendezvousRole>

The role resolved by the cookie contest, once past RendezvousHandshakeState::Waving.

Source

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

The negotiated parameters, once RendezvousHandshakeState::Connected.

Source

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

Builds the initial WAVEAHAND handshake (§4.3.2, L2100/L2153-2170: Version 5, this side’s own cookie, no extensions) and transitions to RendezvousHandshakeState::Waving.

§Errors

Error::HandshakeOutOfSequence if called more than once.

Source

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

Feeds an inbound control packet.

A non-Handshake ControlPacket fed while this side is a Responder stuck in RendezvousHandshakeState::Initiated is treated as missing-packet recovery rule 3 (L2413-2422: “any control packet normally only sent between connected parties”) rather than an error — see Self::on_recovery_trigger for the data-packet analogue.

§Errors

Error::UnexpectedControlPacket for a non-Handshake packet outside that one recovery case; Error::HandshakeOutOfSequence if fed before Self::start or after a terminal state (a driver bug, not a peer protocol failure).

Source

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

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

Source

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

Missing-packet recovery rule 3 (§4.3.2.2, L2413-2422): call this when the driver receives a data packet (SrtPacket::Data) while this side has not yet reached RendezvousHandshakeState::Connected. A no-op (Ok(Vec::new())) unless this side is a Responder stuck in RendezvousHandshakeState::Initiated — the one case the draft says is “exceptionally allowed” to promote to Connected “as if it had received AGREEMENT”.

Source

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

Advances retransmit timing by one caller-defined tick, mirroring crate::caller::CallerHandshake::tick / crate::listener::ListenerHandshake::tick.

Trait Implementations§

Source§

impl Debug for RendezvousHandshake

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.