oci-set-call-timeout.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ed6de1ae20ce16c0c7be0b3fef282b6065bebfac Maintainer: lex Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.oci-set-call-timout" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>oci_set_call_timeout</refname>
  <refpurpose>Устанавливает время ожидания в миллисекундах для вызовов базы данных</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>
   Устанавливает время ожидания, ограничивающее максимальное время кругового пути (round-trip) базы данных при использовании этого подключения.
  </para>
  <para>
   Каждая операция OCI8 может выполнять ноль или более вызовов к клиентской библиотеки Oracle.
   Затем эти внутренние вызовы могут привести к нулевому или большему количеству обращений к базе данных Oracle.
   Если какой-либо из этих циклических обходов занимает больше миллисекунд, чем указано в <literal>time_out</literal>,
   операция отменяется и приложению возвращается ошибка.
  </para>
  <para>
   Значение <literal>time_out</literal> применяется к каждому циклу в отдельности,
   а не к сумме всех циклов в оба конца.
   Время, затраченное на обработку в PHP OCI8 до или после завершения каждого циклического пути, не учитывается.
  </para>
  <para>
   При прерывании вызова Oracle попытается очистить соединение для повторного использования.
   Данная операция может быть запущена для другого периода <literal>time_out</literal>.
   В зависимости от результатов очистки подключение может использоваться повторно.
  </para>
  <para>
   При использовании постоянных соединений значение времени ожидания сохраняется в запросах PHP.
  </para>
  <para>
   Функция <function>oci_set_call_timeout</function> доступна,
   когда OCI8 использует клиентские библиотеки Oracle 18 (или более поздней версии).
  </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>
       Максимальное время в миллисекундах, которое может занять один циклический путь (round-trip) между PHP и базой данных Oracle
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Установка времени ожидания</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
-->