mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-09-22 06:11:32 +02:00
c4943d5170
The purpose is to manipulate rings made of series of buffers so that it is possible to continue to work on a next buffer once one is full. This will be used by muxes to deal with contention between multiple streams and a single output buffer. No data is expected to span over multiple buffers, all of them will be used like a regular buffer. This will significantly limit the amount of changes and the code complexity while still supporting larger output buffering. The ring is made of a head and a tail indexes both of which point to a buffer descriptor. At least one descriptor is always valid, so it could be seen as a form of pagination always presenting one buffer. The root of the ring is itself stored into a buffer descriptor so that the user only has to declare a buffer array and to call br_init() on it in order to use it.
The HAProxy documentation has been split into a number of different files for ease of use. Please refer to the following files depending on what you're looking for : - INSTALL for instructions on how to build and install HAProxy - LICENSE for the project's license - CONTRIBUTING for the process to follow to submit contributions The more detailed documentation is located into the doc/ directory : - doc/intro.txt for a quick introduction on HAProxy - doc/configuration.txt for the configuration's reference manual - doc/lua.txt for the Lua's reference manual - doc/SPOE.txt for how to use the SPOE engine - doc/network-namespaces.txt for how to use network namespaces under Linux - doc/management.txt for the management guide - doc/regression-testing.txt for how to use the regression testing suite - doc/peers.txt for the peers protocol reference - doc/coding-style.txt for how to adopt HAProxy's coding style - doc/internals for developer-specific documentation (not all up to date)