1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-25 07:52:21 +01:00
Files
archived-doc-es/reference/mongo/mongocursor/timeout.xml
Pedro Antonio Gil Rodríguez 41bf49796f Actualización a la última versión
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@337046 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-24 16:46:37 +00:00

136 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9f0e1e36a3eeac3652b724a834dbf241a8c90527 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mongocursor.timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoCursor::timeout</refname>
<refpurpose>Establece un tiempo de espera en el lado del cliente para esta consulta</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::timeout</methodname>
<methodparam><type>int</type><parameter>ms</parameter></methodparam>
</methodsynopsis>
<para>
Se puede establecer un tiempo de espera en cualquier momento y afectará a consultas subsiguientes del
cursor, incluyendo la obtención de más resultados desde la base de datos.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>ms</parameter>
</term>
<listitem>
<para>
El número de milisegundos que ha de esperar el cursor a una respuesta. Use
<literal>-1</literal> para esperar eternamente. Por omisión, el cursor esperará
<varname>30000</varname> milisegundos (30 segundos).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Este cursor.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Hace que los métodos que obtienen resultados lancen una
<classname>MongoCursorTimeoutException</classname> si la consulta toma más
tiempo de los milisegundos especificados.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Ejemplo de <function>MongoCursor::timeout</function></title>
<para>
En el siguiente ejemplo, el controlador esperará a una respuesta inicial
de la base de datos, y luego esperará 100 ms para las respuestas subsiguientes.
</para>
<programlisting role="php">
<![CDATA[
<?php
$cursor = $collection->find();
$cursor->timeout(-1);
/* $cursor->hasNext() ejecuta la consulta. Se ha establecido un tiempo de espera
* infinito, por lo que el controlador esperará lo necesario a una respuesta.
*/
while ($cursor->hasNext()) {
$cursor->timeout(100);
/* Ahora se ha establecido el tiempo de espera, por lo que, si el cursor necesita obtener
* más resultados de la base de datos, solo esperará 100 ms a una respuesta.
*/
try {
print_r($cursor->getNext());
} catch (MongoCursorTimeoutException $e) {
echo "¡La consulta tomó demasiado tiempo!";
}
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
Esto no hace que el servidor de MongoDB cancele las operaciones que se ejecuten durante mucho tiempo;
solamente instruye al controlador para que deje de esperar a una respuesta y lance una
<classname>MongoCursorTimeoutException</classname> después de un tiempo establecido.
Si fuera necesario especificar un tiempo límite para una consulta, se puede considerar el uso de
<methodname>MongoCursor::maxTimeMS</methodname>.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoCursorInterface::timeout</methodname></member>
<member>La opción <literal>socketTimeoutMS</literal> de <function>MongoClient::__construct</function></member>
</simplelist>
</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
-->