archived-doc-es/reference/mongo/mongopool/info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8a4640c71cd1b8b6ad42f5c58ba0daacfea739c4 Maintainer: chuso Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->

<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>Devuelve información sobre todos los agrupamientos de conexiones</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>MongoPool::info</methodname>
   <void/>
  </methodsynopsis>
  
  <para>
   Devuelve un array con información sobre todos los agrupamientos de conexiones.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Cada agrupamiento de conexiones tiene un identificador que comienza con el nombre de host.
   Esta función muestra los siguientes campos para cada agrupamiento:
   <variablelist>
    <varlistentry>
     <term>
      <parameter>in use</parameter>
     </term>
     <listitem>
      <para>
       El número de conexiones actualmente usadas por instancias de
       <classname>Mongo</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>in pool</parameter>
     </term>
     <listitem>
      <para>
       El número de conexiones que hay actualmente en el agrupamiento (sin usar).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>remaining</parameter>
     </term>
     <listitem>
      <para>
       El número de conexiones que podrían crearse en este agrupamiento. Por ejemplo,
       supongamos que un agrupamiento tenía 5 conexiones pendientes y 3 conexiones
       en el agrupamiento. Podríamos crear 8 nuevas instancias de
       <classname>MongoClient</classname> antes de agotar este agrupamiento
       (asumiendo que ninguna instancia de <classname>MongoClient</classname> quedó fuera
       de ámbito, devolviendo sus conexiones al agrupamiento).
      </para>
      <para>
       Un número negativo indica que este agrupamiento generará conexiones ilimitadas.
      </para>
      <para>
       Antes de crear un agrupamiento, se puede cambiar el número máximo de conexiones
       invocando a <function>Mongo::setPoolSize</function>. Una vez que se ha llamado a
       esta función, no se podrá modificar su tamaño.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>total</parameter>
     </term>
     <listitem>
      <para>
       El número total de conexiones permitidas en este agrupamiento. Debería ser
       mayor o igual a la suma de "in use" + "in pool" (o -1).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>timeout</parameter>
     </term>
     <listitem>
      <para>
       El tiempo máximo de espera del socket para las conexiones de este agrupamiento.
       Indica por cuánto tiempo la agrupación intentará conectarse con un servidor antes
       de darse por vencidas.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>waiting</parameter>
     </term>
     <listitem>
      <para>
       Si se ha restringido el tamaño del agrupamiento, los procesos que soliciten conexiones
       de este agrupamiento podrán quedarse bloqueados hasta que otros procesos devuelvan sus
       conexiones. Este campo indica por cuántos milisegundos quedarán bloqueados esperando a que
       se libere una conexión. Si este número creciera demasiado, quizás sea conveniente usar
       <function>MongoPool::setSize</function> para añadir más conexiones al
       agrupamiento.
      </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>Emite un error de nivel <constant>E_DEPRECATED</constant> cuando se usa.</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
-->