Document wtimeout and wTimeoutMS properly.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330322 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2013-05-20 23:09:32 +00:00
parent d5e21642fe
commit a7deeda999

View file

@ -211,21 +211,13 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
How long a send or receive on a socket can take before timing out.
<note>
<simpara>
This is a client side timeout. If a <literal>insert</literal> hits
the socketTimeoutMS there is no way to know if the server actually
received the write or not.
This is a client side timeout. If an <literal>insert</literal> hits
the <literal>"socketTimeoutMS"</literal> value there is no way to
know if the server actually received the write or not.
</simpara>
</note>
</para>
</listitem>
<listitem>
<para>
<literal>"timeout"</literal>
</para>
<para>
Deprecated alias for "connectTimeoutMS"
</para>
</listitem>
<listitem>
<para>
<literal>"username"</literal>
@ -265,7 +257,7 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
</listitem>
<listitem>
<para>
<literal>"wTimeout"</literal>
<literal>"wTimeoutMS"</literal>
</para>
<para>
This option is used in combination with the <literal>"w"</literal>
@ -277,6 +269,27 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
</listitem>
</itemizedlist>
</para>
<para>
The following options are deprecated and should no longer be used:
<itemizedlist>
<listitem>
<para>
<literal>"timeout"</literal>
</para>
<para>
Deprecated alias for "connectTimeoutMS".
</para>
</listitem>
<listitem>
<para>
<literal>"wTimeout"</literal>
</para>
<para>
Deprecated alias for "wTimeoutMS".
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
@ -313,6 +326,15 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
</row>
</thead>
<tbody>
<row>
<entry>1.4.0</entry>
<entry>
<para>
Added the <literal>"wTimeoutMS"</literal> option has replacement
for <literal>"wTimeout"</literal>.
</para>
</entry>
</row>
<row>
<entry>1.3.4</entry>
<entry>