DOC: stconn: Improve comments about lra and fsb usage

Recent fixes have shown <lra> and <fsb> uses were not prettu clear. So let's
try to improve documentation about these value. Especially when <lra> is
updated and how to used it.
This commit is contained in:
Christopher Faulet 2023-11-07 07:55:51 +01:00
parent e5fe2013a9
commit 62812b2a1d

View File

@ -256,13 +256,17 @@ struct stconn;
* endpoint itself (mux/applet) and eventually creates a new sedesc (for * endpoint itself (mux/applet) and eventually creates a new sedesc (for
* instance on connection retries). * instance on connection retries).
* *
* <lra> should be updated when a read activity is detected. It can be a * <lra> should be updated when a read activity at the endpoint level is
* successful receive, when a shutr is reported or when receives are * detected. It can be a successful receive or when a EOS/EOI is reported.
* unblocked. * A read activity is also reported when receives are unblocked.
* <fsb> should be updated when the first send of a series is blocked and reset * <fsb> should be updated when the first send of a series is blocked and reset
* when a successful send is reported. * when a successful send is reported.
* *
*
* NOTE: <lra> and <fsb> must only be used via the SC api to compute read/write
* expiration date.
*
*/ */
struct sedesc { struct sedesc {
void *se; /* the stream endpoint, i.e. the mux stream or the appctx */ void *se; /* the stream endpoint, i.e. the mux stream or the appctx */