haproxy/doc/internals/api
Christopher Faulet 5ead611cc2 MEDIUM: htx: Add htx_xfer function to replace htx_xfer_blks
htx_xfer() function should replace htx_xfer_blks(). It will be a bit easier to
maintain and to use. The behavior of htx_xfer() can be changed by calling it
with specific flags:

  * HTX_XFER_KEEP_SRC_BLKS: Blocks from the source message are just copied
  * HTX_XFER_PARTIAL_HDRS_COPY: It is allowed to partially xfer headers or trailers
  * HTX_XFER_HDRS_ONLY: only headers are xferred

By default (HTX_XFER_DEFAULT or 0), all blocks from the source message are moved
into to the destination mesage. So copied in the destination messageand removed
from the source message.

The caller must still define the maximum amount of data (including meta-data)
that can be xferred.

It is no longer necessary to specify a block type to stop the copy. Most of
time, with htx_xfer_blks(), this parameter was set to HTX_BLK_UNUSED. And
otherwise it was only specified to transfer headers.

It is important to not that the caller is responsible to verify the original
HTX message is well-formated. Especially, it must be sure headers part and
trailers part are complete (finished by EOH/EOT block).

For now, htx_xfer_blks() is not removed for compatiblity reason. But it is
deprecated.
2026-03-23 14:02:42 +01:00
..
appctx.txt CLEANUP: assorted typo fixes in the code and comments 2022-08-06 17:12:51 +02:00
buffer-api.txt MINOR: dynbuf: pass a criticality argument to b_alloc() 2024-05-10 17:18:13 +02:00
buffer-list-api.txt DOC: fix typos in the documentation files 2026-01-20 08:15:28 +01:00
event_hdl.txt [RELEASE] Released version 3.1-dev2 2024-06-29 11:28:41 +02:00
filters.txt [RELEASE] Released version 2.9-dev9 2023-11-04 09:38:16 +01:00
htx-api.txt MEDIUM: htx: Add htx_xfer function to replace htx_xfer_blks 2026-03-23 14:02:42 +01:00
initcalls.txt DOC: initcall: name correctly REGISTER_CONFIG_POST_SECTION() 2025-02-12 13:27:44 +01:00
ist.txt DOC: internals: document the IST API 2021-11-08 16:50:48 +01:00
layers.txt DOC: internal: add a description of the stream connectors and descriptors 2022-05-27 19:34:36 +02:00
list.txt CLEANUP: assorted typo fixes in the code and comments This is 29th iteration of typo fixes 2022-01-03 14:40:58 +01:00
memory.txt MINOR: tools: also implement ha_aligned_alloc_typed() 2025-08-13 17:37:08 +02:00
mt_list.txt MINOR: mt_list: Implement MT_LIST_POP_LOCKED() 2025-09-30 16:25:07 +02:00
pools.txt DOC: api: update the pools API with the alignment and typed declarations 2025-08-11 19:55:30 +02:00
scheduler.txt BUG/MINOR: stream: Properly handle "on-marked-up shutdown-backup-sessions" 2025-01-28 14:53:37 +01:00