Added that it's a server thing, and emphasised "forever".

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330128 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2013-04-22 14:11:27 +00:00
parent 0109b67c9b
commit 53281c346b

View file

@ -14,20 +14,21 @@
<methodparam choice="opt"><type>bool</type><parameter>liveForever</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
After remaining idle for some amount of time, cursor, by default, "die."
This is generally the behavior one wants. The database cleans up a cursor
once all of its results have been sent to the client, but if the client
doesn't request all of the results, the cursor will languish there, taking up
resources. Thus, after a few minutes, the cursor "times out" and the
database assumes the client has gotten everything it needs and cleans up its
the cursor's resources.
After remaining idle on the server for some amount of time, cursors, by
default, "die." This is generally the behavior one wants. The database
cleans up a cursor once all of its results have been sent to the client,
but if the client doesn't request all of the results, the cursor will
languish there, taking up resources. Thus, after a few minutes, the cursor
"times out" and the database assumes the client has gotten everything it
needs and cleans up its the cursor's resources.
</para>
<para>
If, for some reason, you need a cursor to hang around for a long time, you
can prevent the database from cleaning it up by using this method. However,
if you make a cursor immortal, you need to iterate through all of its results
(or at least until <methodname>MongoCursor::dead</methodname> returns &true;) or the
cursor will hang around the database forever, taking up resources.
If, for some reason, you need a cursor to hang around for a long time, you
can prevent the database from cleaning it up by using this method.
However, if you make a cursor immortal, you need to iterate through all of
its results (or at least until <methodname>MongoCursor::dead</methodname>
returns &true;) or the cursor will hang around the database
<emphasis>forever</emphasis>, taking up resources.
</para>
</refsect1>