oci-register-taf-callback.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ed6de1ae20ce16c0c7be0b3fef282b6065bebfac Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.oci-register-taf-callback" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>oci_register_taf_callback</refname>
  <refpurpose>Регистрирует пользовательскую функцию обратного вызова для Oracle Database TAF</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>oci_register_taf_callback</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter></methodparam>
  </methodsynopsis>
  <para>
   Регистрирует пользовательскую функцию обратного вызова для соединения
   <parameter>connection</parameter>.
   Если соединение <parameter>connection</parameter> оборвалось из-за проблем с БД или
   сетью, будет произведено несколько запусков зарегистрированной функции в процессе
   восстановления. Более подробно читайте <link linkend="oci8.taf">OCI8 Transparent Application Failover (TAF) Support</link> .
  </para>
  <para>
   Каждый новый вызов <function>oci_register_taf_callback</function> будет затирать
   предыдущие регистрации.
  </para>
  <para>
   Для явного удаления регистрации используйте функцию
   <function>oci_unregister_taf_callback</function>.
  </para>
  <para>
   Регистрация функции обратного вызова НЕ сохраняется для постоянных соединений,
   следовательно при каждом новом постоянном соединении её необходимо
   перерегистрировать.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Идентификатор соединения Oracle.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       Пользовательская функция для регистрации для Oracle TAF. Может быть как
       строкой с именем функции, так и замыканием (анонимной функцией).
      </para>
      <para>
       Интерфейс функции следующий:
      </para>
      <methodsynopsis>
       <type>int</type><methodname>userCallbackFn</methodname>
       <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
       <methodparam><type>int</type><parameter>event</parameter></methodparam>
       <methodparam><type>int</type><parameter>type</parameter></methodparam>
      </methodsynopsis>
      <para>
       Описание параметров и примеры смотрите на странице <link linkend="oci8.taf">
       OCI8 Transparent Application Failover (TAF) Support</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>oci_unregister_taf_callback</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
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
-->