]> git.ipfire.org Git - thirdparty/haproxy.git/commit
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)
committerChristopher Faulet <cfaulet@haproxy.com>
Mon, 14 Jun 2021 10:03:32 +0000 (12:03 +0200)
commit095303956708a3f87594ae60cd9d7df12d12d905
tree48aabd6f6456b16f756d4d81ec459f93b12f17d9
parentcaef19e0c7594b00aa341d8984a33ddd0f15113f
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.
doc/lua-api/index.rst