DOC: lua: Add a warning about buffers modification in HTTP
authorChristopher Faulet <cfaulet@haproxy.com>
Mon, 14 Jun 2021 09:43:18 +0000 (11:43 +0200)
committerWilly Tarreau <w@1wt.eu>
Thu, 17 Jun 2021 16:14:43 +0000 (18:14 +0200)
commit52e53bdc43d924c789f7b82aac7b9f4ce384ec31
tree9b927a00e1c4f4ebbe8e6d04c30e752855746ca9
parent7e0d0d8815ca60fbd5d54bdcb379e5b79de02f51
DOC: lua: Add a warning about buffers modification in HTTP

Since the 1.9, it is forbidden to alter the channel buffer from an HTTP
stream because there is no way to keep the HTTP parser synchronized if the
buffer content is altered. In addition, since the HTX is the only
reprensentation for HTTP messages, the data in HTTP buffers are structured
and cannot be read or updated in a raw fashion.

A warning is triggered when a user tries to alter an HTTP buffer. However,
it was not documented. This patch adds a warning in the lua documentation.

This patch is related to the issue #1287. It may be backported as far as
2.0.

(cherry picked from commit 095303956708a3f87594ae60cd9d7df12d12d905)
Signed-off-by: Willy Tarreau <w@1wt.eu>
(cherry picked from commit 1cda6c8bd2461819cfc7b3c9625b2cb49d808406)
Signed-off-by: Willy Tarreau <w@1wt.eu>
doc/lua-api/index.rst