diff options
author | Michael Grunder <michael.grunder@gmail.com> | 2020-05-26 10:06:28 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-26 10:06:28 -0700 |
commit | e553e0f382394ea055d0b6b7637ab2534cf38146 (patch) | |
tree | 07d7a1945dbf045dfd09b00cec74ce7112096fe6 | |
parent | f5d258504333d5598428853b7293e26814f65acf (diff) |
Document allocator injection and completeness fix in test.c (#824)
-rw-r--r-- | README.md | 30 | ||||
-rw-r--r-- | test.c | 3 |
2 files changed, 32 insertions, 1 deletions
@@ -474,6 +474,36 @@ Instead, use `redisInitiateSSL()` which also provides greater control over the configuration of the SSL connection, as the caller is responsible to create a connection context using `SSL_new()` and configure it as required. +## Allocator injection + +Hiredis uses a pass-thru structure of function pointers defined in +[alloc.h](https://github.com/redis/hiredis/blob/f5d25850/alloc.h#L41) that conttain +the currently configured allocation and deallocation functions. By default they +just point to libc (`malloc`, `calloc`, `realloc`, etc). + +### Overriding + +One can override the allocators like so: + +```c +hiredisAllocFuncs myfuncs = { + .mallocFn = my_malloc, + .callocFn = my_calloc, + .reallocFn = my_realloc, + .strdupFn = my_strdup, + .freeFn = my_free, +}; + +// Override allocators (function returns current allocators if needed) +hiredisAllocFuncs orig = hiredisSetAllocators(&myfuncs); +``` + +To reset the allocators to their default libc function simply call: + +```c +hiredisResetAllocators(); +``` + ## AUTHORS Hiredis was written by Salvatore Sanfilippo (antirez at gmail) and @@ -550,7 +550,8 @@ static void test_allocator_injection(void) { .mallocFn = hi_malloc_fail, .callocFn = hi_calloc_fail, .reallocFn = hi_realloc_fail, - .freeFn = NULL, + .strdupFn = strdup, + .freeFn = free, }; // Override hiredis allocators |