Debian Codegraph @

upstream/debian-unstable/man3/OSSL_sleep.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_SLEEP 3SSL"
58 .TH OSSL_SLEEP 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_sleep \- delay execution for a specified number of milliseconds
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/crypto.h>
69 \&
70 \& void OSSL_sleep(uint64_t millis);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBOSSL_sleep()\fR is a convenience function to delay execution of the calling
75 thread for (at least) \fImillis\fR milliseconds. The delay is not guaranteed;
76 it may be affected by system activity, by the time spent processing the call,
77 limitation on the underlying system call parameter size or by system timer
78 granularity.
79 .PP
80 In particular on Windows the maximum amount of time it will sleep is
81 49 days and on systems where the regular \fBsleep\fR\|(3) is used as the underlying
82 system call the maximum sleep time is about 136 years.
83 .SH "RETURN VALUES"
84 .IX Header "RETURN VALUES"
85 \&\fBOSSL_sleep()\fR does not return any value.
86 .SH HISTORY
87 .IX Header "HISTORY"
88 \&\fBOSSL_sleep()\fR was added in OpenSSL 3.2.
89 .SH COPYRIGHT
90 .IX Header "COPYRIGHT"
91 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
92 .PP
93 Licensed under the Apache License 2.0 (the "License"). You may not use
94 this file except in compliance with the License. You can obtain a copy
95 in the file LICENSE in the source distribution or at
96 <https://www.openssl.org/source/license.html>.