php-doc-en/reference/sqlite/functions/sqlite-busy-timeout.xml
Kenneth Schwartz 43b3558404 Add/Update examples (incorp. user notes)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@177193 c90b9560-bf6c-de11-be94-00142212c4b1
2005-01-14 05:42:48 +00:00

83 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.sqlite-busy-timeout">
<refnamediv>
<refname>sqlite_busy_timeout</refname>
<refname>SQLiteDatabase->busyTimeout</refname>
<refpurpose>Set busy timeout duration, or disable busy handlers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>sqlite_busy_timeout</methodname>
<methodparam><type>resource</type><parameter>dbhandle</parameter></methodparam>
<methodparam><type>int</type><parameter>milliseconds</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>SQLiteDatabase</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>busyTimeout</methodname>
<methodparam><type>int</type><parameter>milliseconds</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Set the maximum time that sqlite will wait for a
<parameter>dbhandle</parameter>
to become ready for use to <parameter>milliseconds</parameter>.
If <parameter>milliseconds</parameter> is <literal>0</literal>, busy
handlers will be disabled and sqlite will return immediately with a
<literal>SQLITE_BUSY</literal> status code if another process/thread has
the database locked for an update.
</para>
<para>
PHP sets the default busy timeout to be 60 seconds when the database is
opened.
</para>
<para>
<example>
<title><function>sqlite_busy_timeout</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dbhandle = sqlite_open('sqlitedb');
sqlite_busy_timeout($dbhandle, 10000); // set timeout to 10 seconds
sqlite_busy_timeout($dbhandle, 0); // disable busy handler
/* OO Example */
$dbhandle = new SQLiteDatabase('sqlitedb');
$dbhandle->busyTimeout(10000); // 10 seconds
$dbhandle->busyTimeout(0); // disable
?>]]>
</programlisting>
</example>
</para>
<note>
<para>
There are one thousand (1000) milliseconds in one second.
</para>
</note>
<para>
See also <function>sqlite_open</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->