diff options
Diffstat (limited to 'upstream/debian-unstable/man3/OSSL_sleep.3ssl')
-rw-r--r-- | upstream/debian-unstable/man3/OSSL_sleep.3ssl | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/OSSL_sleep.3ssl b/upstream/debian-unstable/man3/OSSL_sleep.3ssl new file mode 100644 index 00000000..7086c490 --- /dev/null +++ b/upstream/debian-unstable/man3/OSSL_sleep.3ssl @@ -0,0 +1,96 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "OSSL_SLEEP 3SSL" +.TH OSSL_SLEEP 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 +.nh +.SH NAME +OSSL_sleep \- delay execution for a specified number of milliseconds +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/crypto.h> +\& +\& void OSSL_sleep(uint64_t millis); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBOSSL_sleep()\fR is a convenience function to delay execution of the calling +thread for (at least) \fImillis\fR milliseconds. The delay is not guaranteed; +it may be affected by system activity, by the time spent processing the call, +limitation on the underlying system call parameter size or by system timer +granularity. +.PP +In particular on Windows the maximum amount of time it will sleep is +49 days and on systems where the regular \fBsleep\fR\|(3) is used as the underlying +system call the maximum sleep time is about 136 years. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBOSSL_sleep()\fR does not return any value. +.SH HISTORY +.IX Header "HISTORY" +\&\fBOSSL_sleep()\fR was added in OpenSSL 3.2. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2022\-2023 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 +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |