projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 82d28c6b RL |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | OSSL_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 | ||
| 15 | OSSL_sleep() is a convenience function to delay execution of the calling | |
| 16 | thread for (at least) I<millis> milliseconds. The delay is not guaranteed; | |
| bea92b8c TM |
17 | it may be affected by system activity, by the time spent processing the call, |
| 18 | limitation on the underlying system call parameter size or by system timer | |
| 19 | granularity. | |
| 20 | ||
| 21 | In particular on Windows the maximum amount of time it will sleep is | |
| 22 | 49 days and on systems where the regular sleep(3) is used as the underlying | |
| 23 | system call the maximum sleep time is about 136 years. | |
| 82d28c6b RL |
24 | |
| 25 | =head1 RETURN VALUES | |
| 26 | ||
| 27 | OSSL_sleep() does not return any value. | |
| 28 | ||
| 29 | =head1 HISTORY | |
| 30 | ||
| 31 | OSSL_sleep() was added in OpenSSL 3.2. | |
| 32 | ||
| 33 | =head1 COPYRIGHT | |
| 34 | ||
| da1c088f | 35 | Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved. |
| 82d28c6b RL |
36 | |
| 37 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
| 38 | this file except in compliance with the License. You can obtain a copy | |
| 39 | in the file LICENSE in the source distribution or at | |
| 40 | L<https://www.openssl.org/source/license.html>. | |
| 41 | ||
| 42 | =cut |