blob: 8db0833982c37b3fd3f313898d8d2097f8e6c236 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
.Dd January 24, 2024
.Dt SQLITE3_BUSY_TIMEOUT 3
.Os
.Sh NAME
.Nm sqlite3_busy_timeout
.Nd set a busy timeout
.Sh SYNOPSIS
.In sqlite3.h
.Ft int
.Fo sqlite3_busy_timeout
.Fa "sqlite3*"
.Fa "int ms"
.Fc
.Sh DESCRIPTION
This routine sets a busy handler that sleeps for a specified
amount of time when a table is locked.
The handler will sleep multiple times until at least "ms" milliseconds
of sleeping have accumulated.
After at least "ms" milliseconds of sleeping, the handler returns 0
which causes
.Fn sqlite3_step
to return SQLITE_BUSY.
.Pp
Calling this routine with an argument less than or equal to zero turns
off all busy handlers.
.Pp
There can only be a single busy handler for a particular database connection
at any given moment.
If another busy handler was defined (using
.Fn sqlite3_busy_handler )
prior to calling this routine, that other busy handler is cleared.
.Pp
.Sh IMPLEMENTATION NOTES
These declarations were extracted from the
interface documentation at line 2842.
.Bd -literal
SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
.Ed
.Sh SEE ALSO
.Xr sqlite3 3 ,
.Xr sqlite3_busy_handler 3 ,
.Xr sqlite3_step 3 ,
.Xr SQLITE_OK 3
|
