diff options
| author | Mattias Andrée <maandree@kth.se> | 2021-12-24 21:24:00 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2021-12-24 21:24:00 +0100 |
| commit | e974f623f88c3f38209117408c6db9cdb9d7c080 (patch) | |
| tree | 5b544fcf23462e5a3ae0d6105086f6017333fcf8 /libkeccak_zerocopy_chunksize.3 | |
| parent | Update library version number (diff) | |
| download | libkeccak-e974f623f88c3f38209117408c6db9cdb9d7c080.tar.gz libkeccak-e974f623f88c3f38209117408c6db9cdb9d7c080.tar.bz2 libkeccak-e974f623f88c3f38209117408c6db9cdb9d7c080.tar.xz | |
Add man pages for zero-copy functions
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_zerocopy_chunksize.3')
| -rw-r--r-- | libkeccak_zerocopy_chunksize.3 | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/libkeccak_zerocopy_chunksize.3 b/libkeccak_zerocopy_chunksize.3 new file mode 100644 index 0000000..b507c7f --- /dev/null +++ b/libkeccak_zerocopy_chunksize.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_ZEROCOPY_CHUNKSIZE 3 LIBKECCAK +.SH NAME +libkeccak_zerocopy_chunksize - Get chunk size for zero-copy processing +.RB ( ADVANCED ) +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +size_t libkeccak_zerocopy_chunksize(struct libkeccak_state *\fIstate\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_zerocopy_chunksize () +function returns the number of bytes the sponge +in the +.I state +parameter processes per round. Input to the +.BR libkeccak_zerocopy_update (3) +function must be an integer multiple of this +number, and memory allocated for the +.BR libkeccak_zerocopy_digest (3) +function must also be a multiple of this +number (further restrictions apply, see +.BR libkeccak_zerocopy_digest (3) +for more details.) +.SH RETURN VALUES +The +.BR libkeccak_zerocopy_chunksize () +function returns the number of bytes that +the sponge processes per processing round. +.SH ERRORS +The +.BR libkeccak_zerocopy_chunksize () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_zerocopy_update (3), +.BR libkeccak_zerocopy_digest (3) |