From: Christopher Faulet <cfaulet@haproxy.com>
Date: Tue, 7 Nov 2023 06:55:51 +0000 (+0100)
Subject: DOC: stconn: Improve comments about lra and fsb usage
X-Git-Tag: v2.9-dev10~147
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=62812b2a1d0d7b73b4a64cf3d0fe8256d0d5f5c1;p=thirdparty%2Fhaproxy.git

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.
---

diff --git a/include/haproxy/stconn-t.h b/include/haproxy/stconn-t.h
index 1aace1287a..78c77de9e8 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).
  *
- * <lra> 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.
+ * <lra> 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.
 
  * <fsb> should be updated when the first send of a series is blocked and reset
  *       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 {
 	void *se;                  /* the stream endpoint, i.e. the mux stream or the appctx */