xref: /openssl/doc/man3/OSSL_sleep.pod (revision da1c088f)
1=pod
2
3=head1 NAME
4
5OSSL_sleep - delay execution for a specified number of milliseconds
6
7=head1 SYNOPSIS
8
9 #include <openssl/crypto.h>
10
11 void OSSL_sleep(uint64_t millis);
12
13=head1 DESCRIPTION
14
15OSSL_sleep() is a convenience function to delay execution of the calling
16thread for (at least) I<millis> milliseconds.  The delay is not guaranteed;
17it may be affected by system activity, by the time spent processing the call,
18limitation on the underlying system call parameter size or by system timer
19granularity.
20
21In particular on Windows the maximum amount of time it will sleep is
2249 days and on systems where the regular sleep(3) is used as the underlying
23system call the maximum sleep time is about 136 years.
24
25=head1 RETURN VALUES
26
27OSSL_sleep() does not return any value.
28
29=head1 HISTORY
30
31OSSL_sleep() was added in OpenSSL 3.2.
32
33=head1 COPYRIGHT
34
35Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
36
37Licensed under the Apache License 2.0 (the "License").  You may not use
38this file except in compliance with the License.  You can obtain a copy
39in the file LICENSE in the source distribution or at
40L<https://www.openssl.org/source/license.html>.
41
42=cut
43