diff options
Diffstat (limited to 'upstream/debian-unstable/man3/ASYNC_start_job.3ssl')
| -rw-r--r-- | upstream/debian-unstable/man3/ASYNC_start_job.3ssl | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/upstream/debian-unstable/man3/ASYNC_start_job.3ssl b/upstream/debian-unstable/man3/ASYNC_start_job.3ssl index 5bb291a2..1d09afed 100644 --- a/upstream/debian-unstable/man3/ASYNC_start_job.3ssl +++ b/upstream/debian-unstable/man3/ASYNC_start_job.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASYNC_START_JOB 3SSL" -.TH ASYNC_START_JOB 3SSL 2024-02-03 3.1.5 OpenSSL +.TH ASYNC_START_JOB 3SSL 2024-04-04 3.2.2-dev OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -63,7 +63,8 @@ .SH NAME ASYNC_get_wait_ctx, ASYNC_init_thread, ASYNC_cleanup_thread, ASYNC_start_job, ASYNC_pause_job, -ASYNC_get_current_job, ASYNC_block_pause, ASYNC_unblock_pause, ASYNC_is_capable +ASYNC_get_current_job, ASYNC_block_pause, ASYNC_unblock_pause, ASYNC_is_capable, +ASYNC_stack_alloc_fn, ASYNC_stack_free_fn, ASYNC_set_mem_functions, ASYNC_get_mem_functions \&\- asynchronous job management functions .SH SYNOPSIS .IX Header "SYNOPSIS" @@ -83,6 +84,13 @@ ASYNC_get_current_job, ASYNC_block_pause, ASYNC_unblock_pause, ASYNC_is_capable \& void ASYNC_unblock_pause(void); \& \& int ASYNC_is_capable(void); +\& +\& typedef void *(*ASYNC_stack_alloc_fn)(size_t *num); +\& typedef void (*ASYNC_stack_free_fn)(void *addr); +\& int ASYNC_set_mem_functions(ASYNC_stack_alloc_fn alloc_fn, +\& ASYNC_stack_free_fn free_fn); +\& void ASYNC_get_mem_functions(ASYNC_stack_alloc_fn *alloc_fn, +\& ASYNC_stack_free_fn *free_fn); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -196,6 +204,15 @@ occur. .PP Some platforms cannot support async operations. The \fBASYNC_is_capable()\fR function can be used to detect whether the current platform is async capable or not. +.PP +Custom memory allocation functions are supported for the POSIX platform. +Custom memory allocation functions allow alternative methods of allocating +stack memory such as mmap, or using stack memory from the current thread. +Using an ASYNC_stack_alloc_fn callback also allows manipulation of the stack +size, which defaults to 32k. +The stack size can be altered by allocating a stack of a size different to +the requested size, and passing back the new stack size in the callback's \fI*num\fR +parameter. .SH "RETURN VALUES" .IX Header "RETURN VALUES" ASYNC_init_thread returns 1 on success or 0 otherwise. @@ -214,6 +231,9 @@ or NULL if not within the context of a job. .PP \&\fBASYNC_is_capable()\fR returns 1 if the current platform is async capable or 0 otherwise. +.PP +ASYNC_set_mem_functions returns 1 if custom stack allocators are supported by +the current platform and no allocations have already occurred or 0 otherwise. .SH NOTES .IX Header "NOTES" On Windows platforms the \fI<openssl/async.h>\fR header is dependent on some @@ -374,7 +394,7 @@ ASYNC_start_job, ASYNC_pause_job, ASYNC_get_current_job, \fBASYNC_get_wait_ctx() added in OpenSSL 1.1.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2015\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2015\-2022 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |