RepoMirrors/haproxy
1
0
Fork 0
mirror of http://git.haproxy.org/git/haproxy.git/ synced 2025-01-29 17:42:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC: htx: make it clear that htxbuf() and htx_from_buf() always return valid pointers

Browse Source 
Update the comments above htxbuf() and htx_from_buf() to make it clear
that they always return valid htx pointers so that callers know they do
not have to test them. This is only true after the fix on b_is_null()
which was the only known corner case.

This should be backported to 1.9 if the b_is_null() patch is backported.
This commit is contained in:
Willy Tarreau 2019-01-31 07:21:42 +01:00
parent 203d735cac
commit 245d189cce
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/common/htx.h
View File

@ -690,7 +690,10 @@ static inline size_t buf_room_for_htx_data(const struct buffer *buf)
/* Returns an HTX message using the buffer <buf>. Unlike htx_from_buf(), this
* function does not update to the buffer. */
* function does not update to the buffer.
* Note that it always returns a valid pointer, either to an initialized buffer
* or to the empty buffer.
*/
static inline struct htx *htxbuf(const struct buffer *buf)
{
struct htx *htx;
@ -707,10 +710,10 @@ static inline struct htx *htxbuf(const struct buffer *buf)
/* Returns an HTX message using the buffer <buf>. <buf> is updated to appear as
* full. It is the caller responsibility to call htx_to_buf() when it finish to
* manipulate the HTX message to update <buf> accordingly.
* manipulate the HTX message to update <buf> accordingly. The returned pointer
* is always valid.
*
* If the caller can call htxbuf() function to avoir any update of the
* buffer.
* The caller can call htxbuf() function to avoid any update of the buffer.
*/
static inline struct htx *htx_from_buf(struct buffer *buf)
{