mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
4691215483
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346395 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.3 KiB
XML
117 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.oci-set-call-timout">
|
|
<refnamediv>
|
|
<refname>oci_set_call_timeout</refname>
|
|
<refpurpose>Sets a millisecond timeout for database calls</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>oci_set_call_timeout</methodname>
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>time_out</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets a timeout limiting the maxium time a database round-trip using this connection may take.
|
|
</para>
|
|
<para>
|
|
Each OCI8 operation may make zero or more calls to Oracle's client
|
|
library. These internal calls may then may make zero or more
|
|
round-trips to Oracle Database. If any one of those round-trips
|
|
takes more than <literal>time_out</literal> milliseconds, then the
|
|
operation is cancelled and an error is returned to the application.
|
|
</para>
|
|
<para>
|
|
The <literal>time_out</literal> value applies to each round-trip
|
|
individually, not to the sum of all round-trips. Time spent
|
|
processing in PHP OCI8 before or after the completion of each
|
|
round-trip is not counted.
|
|
</para>
|
|
<para>
|
|
When a call is interrupted, Oracle will attempt to clean up the
|
|
connection for reuse. This operation is allowed to run for
|
|
another <literal>time_out</literal> period. Depending on the
|
|
outcome of the cleanup, the connection may or may not be reusable.
|
|
</para>
|
|
<para>
|
|
When persistent connections are used, the timeout value will be
|
|
retained across PHP requests.
|
|
</para>
|
|
<para>
|
|
The <function>oci_set_call_timeout</function> function is available
|
|
when OCI8 uses Oracle 18 (or later) Client libraries.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
&oci.parameter.connection;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>time_out</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum time in milliseconds that any single round-trip between PHP and Oracle Database may take.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Setting the timeout</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
|
|
oci_set_call_timeout($conn, 5000);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
indent-tabs-mode:nil
|
|
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
|
|
-->
|