xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_busy_timeout.3 (revision a24efa7dea9f1f56c3bdb15a927d3516792ace1c)
1.Dd $Mdocdate$
2.Dt SQLITE3_BUSY_TIMEOUT 3
3.Os
4.Sh NAME
5.Nm sqlite3_busy_timeout
6.Nd Set A Busy Timeout
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3_busy_timeout
10.Fa "sqlite3*"
11.Fa "int ms"
12.Fc
13.Sh DESCRIPTION
14This routine sets a  busy handler that sleeps for a specified
15amount of time when a table is locked.
16The handler will sleep multiple times until at least "ms" milliseconds
17of sleeping have accumulated.
18After at least "ms" milliseconds of sleeping, the handler returns 0
19which causes sqlite3_step() to return SQLITE_BUSY
20or SQLITE_IOERR_BLOCKED.
21.Pp
22Calling this routine with an argument less than or equal to zero turns
23off all busy handlers.
24.Pp
25There can only be a single busy handler for a particular database connection
26any any given moment.
27If another busy handler was defined  (using sqlite3_busy_handler())
28prior to calling this routine, that other busy handler is cleared.
29.Sh SEE ALSO
30.Xr sqlite3 3 ,
31.Xr sqlite3_busy_handler 3 ,
32.Xr sqlite3_step 3 ,
33.Xr SQLITE_OK 3 ,
34.Xr SQLITE_IOERR_READ 3
35