diff options
author | Mattias Andrée <maandree@kth.se> | 2022-02-15 15:38:11 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2022-02-15 15:38:11 +0100 |
commit | d831c660e27d7e62f7613cad1caed169ecf1433e (patch) | |
tree | 2de516846761f1405281f4e2155c5dc7fbdad50b /libar2simplified_init_context.3 | |
parent | Add libar2simplified_recommendation (diff) | |
download | libar2simplified-d831c660e27d7e62f7613cad1caed169ecf1433e.tar.gz libar2simplified-d831c660e27d7e62f7613cad1caed169ecf1433e.tar.bz2 libar2simplified-d831c660e27d7e62f7613cad1caed169ecf1433e.tar.xz |
Add libar2simplified_init_context
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | libar2simplified_init_context.3 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/libar2simplified_init_context.3 b/libar2simplified_init_context.3 new file mode 100644 index 0000000..c6abae7 --- /dev/null +++ b/libar2simplified_init_context.3 @@ -0,0 +1,54 @@ +.TH LIBAR2SIMPLIFIED_INIT_CONTEXT 3 LIBAR2SIMPLIFIED +.SH NAME +libar2simplified_init_context - Create context for libar2_hash + +.SH SYNOPSIS +.nf +#include <libar2simplified.h> + +void libar2simplified_init_context(struct libar2_context *ctxp); +.fi +.PP +Link with +.IR "-lar2simplified -lrt -pthread" . + +.SH DESCRIPTION +The +.BR libar2simplified_init_context () +function initialises the context argument +for the +.BR libar2_hash (3) +function, provided via the +.I ctxp +parameter, with all auto-erase options +turned off. +.PP +This function provides a dynamic memory +management functions that erase memory +before it is deallocated. It also also +provides a multi-threading support using +a thread pool. +.PP +This function is used internally by the +.BR libar2simplified (7) +library, but cannot be used with any +function provided by the library, it can +however be used together with the +.BR libar2 (7) +library, specifically it is designed for the +.BR libar2_hash (3) +function, but can also be used with the +.BR libar2_decode_params (3) +function. + +.SH RETURN VALUES +None. + +.SH ERRORS +The +.BR libar2simplified_recommendation () +function cannot fail. + +.SH SEE ALSO +.BR libar2simplified (7), +.BR libar2_hash (3) |