1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.oci-set-call-timout" xmlns="http://docbook.org/ns/docbook">
<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>timeout</parameter></methodparam>
</methodsynopsis>
<para>
Sets a timeout limiting the maximum 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>timeout</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
-->
|
