SQLITE3_SLEEP(3)

SQLITE3_SLEEP(3) | Library Functions Manual | SQLITE3_SLEEP(3)

# NAME

`sqlite3_sleep` — suspend execution for a short time

# SYNOPSIS

`#include <sqlite3.h>`

int
`sqlite3_sleep`(int);

# DESCRIPTION

The sqlite3_sleep() function causes the current thread to suspend execution for at least a number of milliseconds specified in its parameter.

If the operating system does not support sleep requests with millisecond time resolution, then the time will be rounded up to the nearest second. The number of milliseconds of sleep actually requested from the operating system is returned.

SQLite implements this interface by calling the xSleep() method of the default sqlite3_vfs object. If the xSleep() method of the default VFS is not implemented correctly, or not implemented at all, then the behavior of sqlite3_sleep() may deviate from the description in the previous paragraphs.

If a negative argument is passed to sqlite3_sleep() the results vary by VFS and operating system. Some system treat a negative argument as an instruction to sleep forever. Others understand it to mean do not sleep at all. In SQLite version 3.42.0 and later, a negative argument passed into sqlite3_sleep() is changed to zero before it is relayed down into the xSleep method of the VFS.

# IMPLEMENTATION NOTES

These declarations were extracted from the interface documentation at line 6398.

    SQLITE_API int sqlite3_sleep(int);

# SEE ALSO

sqlite3_vfs(3)

January 24, 2024 | NetBSD 11.0