aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_zerocopy_chunksize.3
blob: b507c7fb882bac0472e2366d277c0ee84a6c8256 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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)