Source of: /manual/en/function.sqlite-busy-timeout.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sqlite.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.sqlite-busy-timeout.php',
1 => 'sqlite_busy_timeout',
),
'up' =>
array (
0 => 'ref.sqlite.php',
1 => 'SQLite Functions',
),
'prev' =>
array (
0 => 'function.sqlite-array-query.php',
1 => 'sqlite_array_query',
),
'next' =>
array (
0 => 'function.sqlite-changes.php',
1 => 'sqlite_changes',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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, 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>
<a name="function.sqlite-busy-timeout.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><b>sqlite_busy_timeout</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$dbhandle</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$milliseconds</tt></span>
)</div>
<p class="para rdfs-comment">Object oriented style (method):</p>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">SQLiteDatabase</b></div>
<div class="methodsynopsis dc-description">
<span class="type">void</span> <span class="methodname"><b>busyTimeout</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$milliseconds</tt></span>
)</div>
</div>
<p class="para">
Set the maximum time, in milliseconds, that SQLite will wait for a
<i><tt class="parameter">dbhandle</tt></i>
to become ready for use.
</p>
</div>
<a name="function.sqlite-busy-timeout.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">dbhandle</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The SQLite Database resource; returned from <a href="function.sqlite-open.php" class="function">sqlite_open()</a>
when used procedurally. This parameter is not required
when using the object-oriented method.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">milliseconds</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The number of milliseconds. When set to
<i>0</i>, busy handlers will be disabled and SQLite will
return immediately with a <i>SQLITE_BUSY</i> 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><p><b class="note">Note</b>:
There are one thousand (1000) milliseconds in one second.
<br />
</p></blockquote>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.sqlite-busy-timeout.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<a name="function.sqlite-busy-timeout.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Procedural style</b></p>
<div class="example-contents programlisting">
<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>
<p class="para">
</p><div class="example">
<p><b>Example #2 Object oriented style</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.sqlite-busy-timeout.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.sqlite-open.php" class="function" rel="rdfs-seeAlso">sqlite_open()</a> - Opens a SQLite database and create the database if it does not exist</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
