openssl/doc/man3/OSSL_sleep.pod
Tomas Mraz bea92b8c3d sleep.c: Limit the sleep time instead of sleeping for days or even years
As the sleep() call is interruptible, it is not even a good idea to call
it in a loop if the caller uses some ridiculously large value as an
infinity just waiting for an interrupt.

Fixes #20524

Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
(Merged from https://github.com/openssl/openssl/pull/20533)
2023-03-18 19:04:58 +01:00

43 lines
1.1 KiB
Plaintext

=pod
=head1 NAME
OSSL_sleep - delay execution for a specified number of milliseconds
=head1 SYNOPSIS
#include <openssl/crypto.h>
void OSSL_sleep(uint64_t millis);
=head1 DESCRIPTION
OSSL_sleep() is a convenience function to delay execution of the calling
thread for (at least) I<millis> 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.
In particular on Windows the maximum amount of time it will sleep is
49 days and on systems where the regular sleep(3) is used as the underlying
system call the maximum sleep time is about 136 years.
=head1 RETURN VALUES
OSSL_sleep() does not return any value.
=head1 HISTORY
OSSL_sleep() was added in OpenSSL 3.2.
=head1 COPYRIGHT
Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
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
L<https://www.openssl.org/source/license.html>.
=cut