mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add clarification to docs on ASYNC_free_pool()

Browse Source 
Clarify that you must only call this after all async jobs have
completed - otherwise you could get memory leaks.

Reviewed-by: Rich Salz <rsalz@openssl.org>
This commit is contained in:
Matt Caswell 2015-10-09 16:39:35 +01:00
parent 000cc411b9
commit 8227255006
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/crypto/ASYNC_start_job.pod
View File

@ -37,16 +37,20 @@ any of the asynchronous job functions, user code should first call
ASYNC_init_pool(). If the user application is multi-threaded, then this should
be done for each thread that will initiate asynchronous jobs. Before user code
exits it should free the pool up (for each thread where a pool was initialised)
using ASYNC_free_pool(). The B<max_size> argument limits the number of
ASYNC_JOBs that will be held in the pool. If B<max_size> is set to 0 then no
upper limit is set. When an ASYNC_JOB is needed but there are none available in
the pool already then one will be automatically created, as long as the total
of ASYNC_JOBs managed by the pool does not exceed B<max_size>. When the pool is
first initialised B<init_size> ASYNC_JOBs will be created immediately. If
ASYNC_init_pool() is not called before the pool is first used then it will be
called automatically with a B<max_size> of 0 (no upper limit) and an
B<init_size> of 0 (no ASYNC_JOBs created up front). If a pool is created in this
way it must still be cleaned up with an explicit call to ASYNC_free_pool().
using ASYNC_free_pool(). No asynchronous jobs must be outstanding for the thread
when ASYNC_free_pool() is called. Failing to ensure this will result in memory
leaks.
The B<max_size> argument limits the number of ASYNC_JOBs that will be held in
the pool. If B<max_size> is set to 0 then no upper limit is set. When an
ASYNC_JOB is needed but there are none available in the pool already then one
will be automatically created, as long as the total of ASYNC_JOBs managed by the
pool does not exceed B<max_size>. When the pool is first initialised
B<init_size> ASYNC_JOBs will be created immediately. If ASYNC_init_pool() is not
called before the pool is first used then it will be called automatically with a
B<max_size> of 0 (no upper limit) and an B<init_size> of 0 (no ASYNC_JOBs
created up front). If a pool is created in this way it must still be cleaned up
with an explicit call to ASYNC_free_pool().
An asynchronous job is started by calling the ASYNC_start_job() function.
Initially B<*job> should be NULL. B<ret> should point to a location where the