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