xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_sleep.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE3_SLEEP 3
3.Os
4.Sh NAME
5.Nm sqlite3_sleep
6.Nd Suspend Execution For A Short Time
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3_sleep
10.Fa "int"
11.Fc
12.Sh DESCRIPTION
13The sqlite3_sleep() function causes the current thread to suspend execution
14for at least a number of milliseconds specified in its parameter.
15.Pp
16If the operating system does not support sleep requests with millisecond
17time resolution, then the time will be rounded up to the nearest second.
18The number of milliseconds of sleep actually requested from the operating
19system is returned.
20.Pp
21SQLite implements this interface by calling the xSleep() method of
22the default sqlite3_vfs object.
23If the xSleep() method of the default VFS is not implemented correctly,
24or not implemented at all, then the behavior of sqlite3_sleep() may
25deviate from the description in the previous paragraphs.
26.Sh SEE ALSO
27.Xr sqlite3_vfs 3
28