lib/libhttp
1
0
Fork 0
mirror of https://github.com/lammertb/libhttp.git synced 2025-08-07 16:02:55 +03:00
Code Activity

Fixed doc interlinks

Browse Source
This commit is contained in:
Lammert Bies
2016-12-16 22:53:09 +01:00
parent aebe5a5f87
commit d71d4f2908
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/httplib_calloc.md
View File

@@ -17,7 +17,7 @@
### Description
The function `httplib_calloc()` tries to allocate a block of memory from the heap for an array elements with a specified size. If this succeeds, the function returns a pointer to the new block. Otherwise the value `NULL` is returned. If a callback function has been registered with the [`set_alloc_callback_func()`](set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter.
The function `httplib_calloc()` tries to allocate a block of memory from the heap for an array elements with a specified size. If this succeeds, the function returns a pointer to the new block. Otherwise the value `NULL` is returned. If a callback function has been registered with the [`httplib_set_alloc_callback_func()`](httplib_set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter.
Due to the allocation of extra data space for tracking the memory allocation, the LibHTTP memory management functions including the `httplib_calloc()` function are incompatible with the memory allocation functions provided by the platform. Memory allocated with one set of functions can not be reallocated or freed by the others. Memory corruption or crashes may occur in that case.

2
doc/api/httplib_free.md
View File

@@ -14,7 +14,7 @@
### Description
The function `httplib_free()` frees a block of memory which has been previously allocated by [`httplib_calloc()`](httplib_calloc.md), [`httplib_malloc()`](httplib_malloc.md) or [`httplib_realloc()`](httplib_realloc.md). If a callback function has been registered with the [`set_alloc_callback_func()`](set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been freed. The amount of bytes passed to the callback function is negative, to indacte that memory has been returned to the heap.
The function `httplib_free()` frees a block of memory which has been previously allocated by [`httplib_calloc()`](httplib_calloc.md), [`httplib_malloc()`](httplib_malloc.md) or [`httplib_realloc()`](httplib_realloc.md). If a callback function has been registered with the [`httplib_set_alloc_callback_func()`](httplib_set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been freed. The amount of bytes passed to the callback function is negative, to indacte that memory has been returned to the heap.
Due to the allocation of extra data space for tracking the memory allocation, the LibHTTP memory management functions including the `httplib_free()` function are incompatible with the memory allocation functions provided by the platform. Memory allocated with one set of functions can not be reallocated or freed by the others. Memory corruption or crashes may occur in that case.

2
doc/api/httplib_malloc.md
View File

@@ -16,7 +16,7 @@
### Description
The function `httplib_malloc()` tries to allocate a block of memory from the heap with a specified size. If this succeeds, the function returns a pointer to the new block. Otherwise the value `NULL` is returned. If a callback function has been registered with the [`set_alloc_callback_func()`](set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter.
The function `httplib_malloc()` tries to allocate a block of memory from the heap with a specified size. If this succeeds, the function returns a pointer to the new block. Otherwise the value `NULL` is returned. If a callback function has been registered with the [`httplib_set_alloc_callback_func()`](httplib_set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter.
Due to the allocation of extra data space for tracking the memory allocation, the LibHTTP memory management functions including the `httplib_malloc()` function are incompatible with the memory allocation functions provided by the platform. Memory allocated with one set of functions can not be reallocated or freed by the others. Memory corruption or crashes may occur in that case.

2
doc/api/httplib_realloc.md
View File

@@ -21,7 +21,7 @@ The function `httplib_realloc()` tries to change the size of an existing allocat
If the `ptr` parameter is NULL, the function `httplib_realloc()` is equivalent to [`httplib_malloc();`](httplib_malloc.md). If the parameter `size` is **0**, the function `httplib_realloc()` will be equal to [`httplib_free();`](httplib_free.md).
If a callback function has been registered with the [`set_alloc_callback_func()`](set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter. Please note that the `current_bytes` parameter passed to the callback function can both be a positive and negative value. A positive value indicates that the size of the memory block has increased while a negative value signals a decrease in the allocated size.
If a callback function has been registered with the [`httplib_set_alloc_callback_func()`](httplib_set_alloc_callback_func.md) function, this function will be called to signal to the main application that a block of memory has been allocated. If a callback function has been registered and the allocation of memory fails, the value **0** is passed as the `current_bytes` parameter. Please note that the `current_bytes` parameter passed to the callback function can both be a positive and negative value. A positive value indicates that the size of the memory block has increased while a negative value signals a decrease in the allocated size.
Due to the allocation of extra data space for tracking the memory allocation, the LibHTTP memory management functions including the `httplib_realloc()` function are incompatible with the memory allocation functions provided by the platform. Memory allocated with one set of functions can not be reallocated or freed by the others. Memory corruption or crashes may occur in that case.