mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
0d604bbc9d
PhD uses this context for decisions about links and similar. It also simplifies the XML git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322205 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.5 KiB
XML
131 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.sqlite-busy-timeout" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>sqlite_busy_timeout</refname>
|
|
<refname>SQLiteDatabase::busyTimeout</refname>
|
|
<refpurpose>Set busy timeout duration, or disable busy handlers</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>&style.oop; (method):</para>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>SQLiteDatabase::busyTimeout</methodname>
|
|
<methodparam><type>int</type><parameter>milliseconds</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Set the maximum time, in milliseconds, that SQLite will wait for a
|
|
<parameter>dbhandle</parameter> to become ready for use.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dbhandle</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The SQLite Database resource; returned from <function>sqlite_open</function>
|
|
when used procedurally. This parameter is not required
|
|
when using the object-oriented method.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>milliseconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of milliseconds. When set to
|
|
<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>
|
|
<note>
|
|
<para>
|
|
There are one thousand (1000) milliseconds in one second.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>&style.procedural;</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
|
|
?>]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>&style.oop;</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$dbhandle = new SQLiteDatabase('sqlitedb');
|
|
$dbhandle->busyTimeout(10000); // 10 seconds
|
|
$dbhandle->busyTimeout(0); // disable
|
|
?>]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>sqlite_open</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|