webrtc_sctp_ack (webrtc v0.1.0)

View Source

SCTP acknowledgement processing, congestion control and retransmission timer (RFC 9260 §6.2.1, §6.3, §7.2, RFC 3758 §3.5).

Internal module of webrtc_sctp_assoc working on the #snd{} record of webrtc_sctp_send. There is a single destination address (SCTP over DTLS is never multi-homed), so cwnd, ssthresh, partial_bytes_acked and the RTO are kept once per association.

Summary

Functions

The timer after an expiry (RFC 9260 §6.3.3 E2): twice Rto, bounded by RTO.Max (rule C7) and by MaxBackoff when set. The cap stops the doubling, it never brings the timer under an RTO the RTT measurements gave, so a long path keeps its timer. WebRTC stacks cap it at a few seconds so that a recovered path is used again quickly (libwebrtc: 3 s).

Process the Cumulative TSN Ack of a SHUTDOWN chunk (RFC 9260 §9.2): like a SACK without gap blocks that does not change the peer window.

Process a SACK chunk. Returns whether new data was acknowledged (which resets the association error counter, RFC 9260 §8.1).

Handle a T3-rtx expiry. Returns whether the expiry counts toward the association error counter: probes of a closed window that keep being answered by SACKs do not (§6.1 A).

Feed a round trip measurement in milliseconds (rules C2, C3, C6, C7 and G1 with a 1 ms clock granularity).

Map a 32-bit wire TSN to the unwrapped TSN closest to Ref (serial number arithmetic, RFC 1982 with SERIAL_BITS = 32).

Functions

backoff(Rto, RtoMax, MaxBackoff)

-spec backoff(pos_integer(), pos_integer(), pos_integer() | infinity) -> pos_integer().

The timer after an expiry (RFC 9260 §6.3.3 E2): twice Rto, bounded by RTO.Max (rule C7) and by MaxBackoff when set. The cap stops the doubling, it never brings the timer under an RTO the RTT measurements gave, so a long path keeps its timer. WebRTC stacks cap it at a few seconds so that a recovered path is used again quickly (libwebrtc: 3 s).

handle_cum_ack(CumW, Now, Snd)

-spec handle_cum_ack(0..4294967295,
                     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()}}) ->
                        {ok,
                         #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()}},
                         boolean()} |
                        {error, protocol_violation}.

Process the Cumulative TSN Ack of a SHUTDOWN chunk (RFC 9260 §9.2): like a SACK without gap blocks that does not change the peer window.

handle_sack(Sctp_sack, Now, Snd)

-spec handle_sack(#sctp_sack{cum_tsn :: 0..4294967295,
                             a_rwnd :: 0..4294967295,
                             gaps :: [{0..65535, 0..65535}],
                             dups :: [0..4294967295]},
                  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()}}) ->
                     {ok,
                      #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()}},
                      boolean()} |
                     {error, protocol_violation}.

Process a SACK chunk. Returns whether new data was acknowledged (which resets the association error counter, RFC 9260 §8.1).

handle_t3(Now, Snd)

-spec handle_t3(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()}},
                    boolean()}.

Handle a T3-rtx expiry. Returns whether the expiry counts toward the association error counter: probes of a closed window that keep being answered by SACKs do not (§6.1 A).

rtt_sample(R0, Snd)

-spec rtt_sample(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()}}.

Feed a round trip measurement in milliseconds (rules C2, C3, C6, C7 and G1 with a 1 ms clock granularity).

unwrap(Wire, Ref)

-spec unwrap(0..4294967295, integer()) -> integer().

Map a 32-bit wire TSN to the unwrapped TSN closest to Ref (serial number arithmetic, RFC 1982 with SERIAL_BITS = 32).