]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: config: Explicitly state the SPOE streams have a usable parent stream
authorChristopher Faulet <cfaulet@haproxy.com>
Fri, 19 Jul 2024 14:29:26 +0000 (16:29 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 19 Jul 2024 14:35:44 +0000 (16:35 +0200)
It is explicitly mentionned in the configuration manual that the parent of a
SPOE stream is the filtered stream. It means variables of the filtered
stream are usable from the SPOE stream.

doc/configuration.txt

index 1edfd219c2c33b25d95a9d8c6a38a0a448c1edbb..06d3ec2de834c31282bfd892a927bd403a4766a0 100644 (file)
@@ -27336,6 +27336,12 @@ also requires dedicated backends, defined in HAProxy configuration.
 SPOE communicates with external components using an in-house binary protocol,
 the Stream Processing Offload Protocol (SPOP).
 
+When the SPOE is used on a stream, a dedicated stream is spawned to handle the
+communcation with the external component. The main stream is the parent stream
+of this "SPOE" stream. It means it is possible to retrieve variables of the
+main stream from the "SPOE" stream. See section 2.8 about variables for
+details.
+
 For all information about the SPOE configuration and the SPOP specification, see
 "doc/SPOE.txt".