<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set busy timeout duration, or disable busy handlers</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlite-array-query.html">sqlite_array_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlite-changes.html">sqlite_changes</a></div>
<div class="up"><a href="ref.sqlite.html">SQLite Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.sqlite-busy-timeout" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlite_busy_timeout</h1>
<h1 class="refname">SQLiteDatabase::busyTimeout</h1>
<p class="verinfo">(PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)</p><p class="refpurpose"><span class="refname">sqlite_busy_timeout</span> -- <span class="refname">SQLiteDatabase::busyTimeout</span> — <span class="dc-title">Set busy timeout duration, or disable busy handlers</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.sqlite-busy-timeout-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>sqlite_busy_timeout</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dbhandle</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$milliseconds</code></span>
)</div>
<p class="para rdfs-comment">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SQLiteDatabase::busyTimeout</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$milliseconds</code></span>
)</div>
<p class="para rdfs-comment">
Set the maximum time, in milliseconds, that SQLite will wait for a
<em><code class="parameter">dbhandle</code></em> to become ready for use.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.sqlite-busy-timeout-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dbhandle</code></em></span>
<dd>
<p class="para">
The SQLite Database resource; returned from <span class="function"><a href="function.sqlite-open.html" class="function">sqlite_open()</a></span>
when used procedurally. This parameter is not required
when using the object-oriented method.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">milliseconds</code></em></span>
<dd>
<p class="para">
The number of milliseconds. When set to
<em>0</em>, busy handlers will be disabled and SQLite will
return immediately with a <em>SQLITE_BUSY</em> status code
if another process/thread has the database locked for an update.
</p>
<p class="para">
PHP sets the default busy timeout to be 60 seconds when the database is
opened.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
There are one thousand (1000) milliseconds in one second.
</p>
</p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.sqlite-busy-timeout-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.sqlite-busy-timeout-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2132">
<p><strong>Example #1 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$dbhandle </span><span style="color: #007700">= </span><span style="color: #0000BB">sqlite_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'sqlitedb'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">sqlite_busy_timeout</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbhandle</span><span style="color: #007700">, </span><span style="color: #0000BB">10000</span><span style="color: #007700">); </span><span style="color: #FF8000">// set timeout to 10 seconds<br /></span><span style="color: #0000BB">sqlite_busy_timeout</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbhandle</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// disable busy handler<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2133">
<p><strong>Example #2 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$dbhandle </span><span style="color: #007700">= new </span><span style="color: #0000BB">SQLiteDatabase</span><span style="color: #007700">(</span><span style="color: #DD0000">'sqlitedb'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$dbhandle</span><span style="color: #007700">-></span><span style="color: #0000BB">busyTimeout</span><span style="color: #007700">(</span><span style="color: #0000BB">10000</span><span style="color: #007700">); </span><span style="color: #FF8000">// 10 seconds<br /></span><span style="color: #0000BB">$dbhandle</span><span style="color: #007700">-></span><span style="color: #0000BB">busyTimeout</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// disable<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.sqlite-busy-timeout-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sqlite-open.html" class="function" rel="rdfs-seeAlso">sqlite_open()</a> - Opens an SQLite database and create the database if it does not exist</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlite-array-query.html">sqlite_array_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlite-changes.html">sqlite_changes</a></div>
<div class="up"><a href="ref.sqlite.html">SQLite Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
