webrtc_sctp_pr (webrtc v0.1.0)
View SourceSCTP partial reliability on the send side (RFC 3758 §3.5, RFC 8260 §2.3.1): abandoning messages, the Advanced.Peer.Ack.Point and FORWARD TSN / I-FORWARD-TSN generation.
Internal module of webrtc_sctp_assoc working on the #snd{} record of webrtc_sctp_send.
Summary
Functions
Abandon every fragment of message Msg (rule A3), including fragments not yet sent, then advance the Advanced.Peer.Ack.Point.
Rule C2: move the Advanced.Peer.Ack.Point over abandoned (and already gap acknowledged) chunks; request a FORWARD TSN if it is now beyond the cumulative ack.
Build the FORWARD TSN or I-FORWARD-TSN (RFC 8260 §2.3.1) chunk.
Functions
-spec abandon(non_neg_integer(), integer(), #snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}) -> #snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}.
Abandon every fragment of message Msg (rule A3), including fragments not yet sent, then advance the Advanced.Peer.Ack.Point.
-spec advance_adv(#snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}) -> #snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}.
Rule C2: move the Advanced.Peer.Ack.Point over abandoned (and already gap acknowledged) chunks; request a FORWARD TSN if it is now beyond the cumulative ack.
-spec forward_tsn(integer(), #snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}) -> {#snd{mtu :: pos_integer(), chunk_mtu :: pos_integer(), idata :: boolean(), pr :: boolean(), max_burst :: pos_integer(), buffer_limit :: pos_integer(), os :: non_neg_integer(), streams :: #{0..65535 => #ostream{queue :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), held :: queue:queue(#omsg{id :: non_neg_integer(), sid :: 0..65535, ppid :: 0..4294967295, data :: binary(), offset :: non_neg_integer(), unordered :: boolean(), mid :: undefined | non_neg_integer(), fsn :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}), bytes :: non_neg_integer(), low :: non_neg_integer(), ssn :: non_neg_integer(), umid :: non_neg_integer(), reset :: none | pending | requested, active :: boolean(), weight :: pos_integer(), vtime :: non_neg_integer()}}, active :: queue:queue(0..65535), vclock :: non_neg_integer(), current :: undefined | 0..65535, buffered :: non_neg_integer(), next_msg :: non_neg_integer(), next_tsn :: non_neg_integer(), cum :: non_neg_integer(), adv :: non_neg_integer(), out :: #{non_neg_integer() => #oc{chunk :: #sctp_data{idata :: boolean(), tsn :: 0..4294967295, sid :: 0..65535, mid :: 0..4294967295, fsn :: 0..4294967295, ppid :: 0..4294967295, unordered :: boolean(), beginning :: boolean(), ending :: boolean(), immediate :: boolean(), data :: binary()}, size :: pos_integer(), len :: non_neg_integer(), state :: inflight | acked | rtx | abandoned, tx :: pos_integer(), sent_at :: integer(), missing :: non_neg_integer(), fast :: boolean(), msg :: non_neg_integer(), max_rtx :: infinity | non_neg_integer(), expires :: infinity | integer()}}, rtx_count :: non_neg_integer(), fast_list :: [non_neg_integer()], flight :: non_neg_integer(), flight_len :: non_neg_integer(), rwnd :: non_neg_integer(), cwnd :: non_neg_integer(), ssthresh :: non_neg_integer(), pba :: non_neg_integer(), fr_exit :: undefined | non_neg_integer(), srtt :: undefined | non_neg_integer(), rttvar :: non_neg_integer(), rto :: pos_integer(), rto_min :: pos_integer(), rto_max :: pos_integer(), max_backoff :: pos_integer() | infinity, rtt_probe :: undefined | {non_neg_integer(), integer()}, t3 :: undefined | integer(), zwp :: undefined | integer(), zwp_interval :: non_neg_integer(), last_sack :: undefined | integer(), fwd_pending :: boolean(), fwd_last :: undefined | {non_neg_integer(), integer()}, last_data_sent :: undefined | integer(), stats :: #{atom() => non_neg_integer()}}, [term()]}.
Build the FORWARD TSN or I-FORWARD-TSN (RFC 8260 §2.3.1) chunk.