OSSL_sleep.pod 1.1 KB

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