34 lines
975 B
Groff
34 lines
975 B
Groff
.Dd December 18, 2016
|
|
.Dt SQLITE3_BUSY_TIMEOUT 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm sqlite3_busy_timeout
|
|
.Nd Set A Busy Timeout
|
|
.Sh SYNOPSIS
|
|
.Ft int SQLITE_STDCALL
|
|
.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 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 sqlite3_busy_handler())
|
|
prior to calling this routine, that other busy handler is cleared.
|
|
.Pp
|
|
.Sh SEE ALSO
|
|
.Xr sqlite3 3 ,
|
|
.Xr sqlite3_busy_handler 3 ,
|
|
.Xr sqlite3_step 3 ,
|
|
.Xr SQLITE_OK 3
|