DOC: config: Move fs.* and bs.* in section about L5 samples
authorChristopher Faulet <cfaulet@haproxy.com>
Tue, 19 Nov 2024 07:49:05 +0000 (08:49 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 22 Nov 2024 14:44:06 +0000 (15:44 +0100)
These sample fetch functions were added in the wrong section. Move them in
the section about sample fetch functions at L5 layer.

(cherry picked from commit e68c6852adb7051a30e209c5a0604f192182b42d)
Signed-off-by: Christopher Faulet <cfaulet@haproxy.com>

doc/configuration.txt

index a91845b..44500cb 100644 (file)
@@ -23057,6 +23057,12 @@ Summary of sample fetch methods in this section and their respective types:
   keyword                                          output type
 -------------------------------------------------+-------------
 51d.all(<prop>[,<prop>*])                          string
+bs.aborted                                         boolean
+bs.id                                              integer
+bs.rst_code                                        integer
+fs.aborted                                         boolean
+fs.id                                              integer
+fs.rst_code                                        integer
 ssl_bc                                             boolean
 ssl_bc_alg_keysize                                 integer
 ssl_bc_alpn                                        string
@@ -23175,12 +23181,41 @@ Detailed list:
       http-request set-header X-51D-DeviceTypeMobileTablet \
         %[51d.all(DeviceType,IsMobile,IsTablet)]
 
+bs.aborted : boolean
+  Returns true is an abort was received from the server for the current
+  stream. Otherwise false is returned.
+
+bs.id : integer
+  Returns the multiplexer's stream ID on the server side. It is the
+  multiplexer's responsibility to return the appropriate information.
+
+bs.rst_code : integer
+  Returns the reset code received from the server for the current stream. The
+  code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
+  the server is returned. The sample fetch fails if no abort was received or if
+  the server stream is not an H2/QUIC stream.
+
 ssl_bc : boolean
   Returns true when the back connection was made via an SSL/TLS transport
   layer and is locally deciphered. This means the outgoing connection was made
   to a server with the "ssl" option. It can be used in a tcp-check or an
   http-check ruleset.
 
+fs.aborted : boolean
+  Returns true is an abort was received from the client for the current
+  stream. Otherwise false is returned.
+
+fs.id : integer
+  Returns the multiplexer's stream ID on the client side. It is the
+  multiplexer's responsibility to return the appropriate information. For
+  instance, on a raw TCP, 0 is always returned because there is no stream.
+
+fs.rst_code : integer
+  Returns the reset code received from the client for the current stream. The
+  code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
+  the client is returned. The sample fetch fails if no abort was received or
+  if the client stream is not an H2/QUIC stream.
+
 ssl_bc_alg_keysize : integer
   Returns the symmetric cipher key size supported in bits when the outgoing
   connection was made over an SSL/TLS transport layer. It can be used in a
@@ -23978,14 +24013,8 @@ Summary of sample fetch methods in this section and their respective types:
 
   keyword                                             output type
 ----------------------------------------------------+-------------
-bs.aborted                                            boolean
-bs.id                                                 integer
-bs.rst_code                                           integer
 distcc_body(<token>[,<occ>])                          binary
 distcc_param(<token>[,<occ>])                         integer
-fs.aborted                                            boolean
-fs.id                                                 integer
-fs.rst_code                                           integer
 payload(<offset>,<length>)                            binary
 payload_lv(<offset1>,<length>[,<offset2>])            binary
 req.len                                               integer
@@ -24016,20 +24045,6 @@ rep_ssl_hello_type                                    integer
 
 Detailed list:
 
-bs.aborted : boolean
-  Returns true is an abort was received from the server for the current
-  stream. Otherwise false is returned.
-
-bs.id : integer
-  Returns the multiplexer's stream ID on the server side. It is the
-  multiplexer's responsibility to return the appropriate information.
-
-bs.rst_code : integer
-  Returns the reset code received from the server for the current stream. The
-  code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
-  the server is returned. The sample fetch fails if no abort was received or if
-  the server stream is not an H2/QUIC stream.
-
 distcc_body(<token>[,<occ>]) : binary
   Parses a distcc message and returns the body associated to occurrence #<occ>
   of the token <token>. Occurrences start at 1, and when unspecified, any may
@@ -24056,21 +24071,6 @@ distcc_param(<token>[,<occ>]) : integer
       # send large files to the big farm
       use_backend big_farm if { distcc_param(DOTI) gt 1000000 }
 
-fs.aborted : boolean
-  Returns true is an abort was received from the client for the current
-  stream. Otherwise false is returned.
-
-fs.id : integer
-  Returns the multiplexer's stream ID on the client side. It is the
-  multiplexer's responsibility to return the appropriate information. For
-  instance, on a raw TCP, 0 is always returned because there is no stream.
-
-fs.rst_code : integer
-  Returns the reset code received from the client for the current stream. The
-  code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
-  the client is returned. The sample fetch fails if no abort was received or
-  if the client stream is not an H2/QUIC stream.
-
 payload(<offset>,<length>) : binary (deprecated)
   This is an alias for "req.payload" when used in the context of a request (e.g.
   "stick on", "stick match"), and for "res.payload" when used in the context of