php-doc-en/reference/mongo/mongopool/info.xml

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

<!-- $Revision$ -->
<refentry xml:id="mongopool.info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoPool::info</refname>
  <refpurpose>Returns information about all connection pools.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>MongoPool::info</methodname>
   <void/>
  </methodsynopsis>

  <para>
   Returns an array of information about all connection pools.
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Each connection pool has an identifier, which starts with the host. For each
   pool, this function shows the following fields:
   <variablelist>
    <varlistentry>
     <term>
      <parameter>in use</parameter>
     </term>
     <listitem>
      <para>
       The number of connections currently being used by
       <classname>Mongo</classname> instances.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>in pool</parameter>
     </term>
     <listitem>
      <para>
       The number of connections currently in the pool (not being used).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>remaining</parameter>
     </term>
     <listitem>
      <para>
       The number of connections that could be created by this pool. For
       example, suppose a pool had 5 connections remaining and 3 connections in
       the pool.  We could create 8 new instances of
       <classname>Mongo</classname> before we exhausted this pool (assuming no
       instances of <classname>Mongo</classname> went out of scope, returning
       their connections to the pool).
      </para>
      <para>
       A negative number means that this pool will spawn unlimited connections.
      </para>
      <para>
       Before a pool is created, you can change the max number of connections by
       calling <function>Mongo::setPoolSize</function>. Once a pool is showing
       up in the output of this function, its size cannot be changed.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>total</parameter>
     </term>
     <listitem>
      <para>
       The total number of connections allowed for this pool.  This should be
       greater than or equal to "in use" + "in pool" (or -1).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>timeout</parameter>
     </term>
     <listitem>
      <para>
       The socket timeout for connections in this pool. This is how long
       connections in this pool will attempt to connect to a server before
       giving up.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>waiting</parameter>
     </term>
     <listitem>
      <para>
       If you have capped the pool size, workers requesting connections from
       the pool may block until other workers return their connections. This
       field shows how many milliseconds workers have blocked for connections to
       be released.  If this number keeps increasing, you may want to use
       <function>MongoPool::setSize</function> to add more connections to your
       pool.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>1.2.11</entry>
       <entry>Emits <constant>E_DEPRECATED</constant> when used.</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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
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
-->