From 62812b2a1d0d7b73b4a64cf3d0fe8256d0d5f5c1 Mon Sep 17 00:00:00 2001 From: Christopher Faulet Date: Tue, 7 Nov 2023 07:55:51 +0100 Subject: [PATCH] DOC: stconn: Improve comments about lra and fsb usage Recent fixes have shown and uses were not prettu clear. So let's try to improve documentation about these value. Especially when is updated and how to used it. --- include/haproxy/stconn-t.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/haproxy/stconn-t.h b/include/haproxy/stconn-t.h index 1aace1287..78c77de9e 100644 --- a/include/haproxy/stconn-t.h +++ b/include/haproxy/stconn-t.h @@ -256,13 +256,17 @@ struct stconn; * endpoint itself (mux/applet) and eventually creates a new sedesc (for * instance on connection retries). * - * should be updated when a read activity is detected. It can be a - * successful receive, when a shutr is reported or when receives are - * unblocked. + * should be updated when a read activity at the endpoint level is + * detected. It can be a successful receive or when a EOS/EOI is reported. + * A read activity is also reported when receives are unblocked. * should be updated when the first send of a series is blocked and reset * when a successful send is reported. * + * + * NOTE: and must only be used via the SC api to compute read/write + * expiration date. + * */ struct sedesc { void *se; /* the stream endpoint, i.e. the mux stream or the appctx */