<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.mysqli-get-links-stats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mysqli_get_links_stats</refname>
  <refpurpose>Return information about open and cached links</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>mysqli_get_links_stats</methodname>
   <void />
  </methodsynopsis>
  <para>
   <function>mysqli_get_links_stats</function> returns information about open
   and cached MySQL links.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>mysqli_get_links_stats</function> returns an associative array
   with three elements, keyed as follows:
   <variablelist>
    <varlistentry>
     <term><parameter>total</parameter></term>
     <listitem>
      <para>
       An <type>int</type> indicating the total number of open links in
       any state.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>active_plinks</parameter></term>
     <listitem>
      <para>
       An <type>int</type> representing the number of active persistent
       connections.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cached_plinks</parameter></term>
     <listitem>
      <para>
       An <type>int</type> representing the number of inactive persistent
       connections.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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
-->