MongoDB: document new functionality for server hedged reads

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349992 c90b9560-bf6c-de11-be94-00142212c4b1

Author: Andreas Braun

reference/mongodb/mongodb/driver/readpreference/construct.xml

@@ -127,6 +127,20 @@
          </row>
         </thead>
         <tbody>
+         <row>
+          <entry>hedge</entry>
+          <entry><type>object|array</type></entry>
+          <entry>
+           <para>Specifies whether to use hedged reads.</para>
+           <para>
+            Server hedged reads are available for all non-primary read preferences
+            and are enabled by default when using the <literal>"nearest"</literal>
+            mode. This object allows explicitly enabling server hedged reads for
+            non-primary read preferences, as well as disabling them for the
+            <literal>"nearest"</literal> read preference.
+           </para>
+          </entry>
+         </row>
          <row>
           <entry>maxStalenessSeconds</entry>
           <entry><type>integer</type></entry>
@@ -230,6 +244,9 @@ var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_NEA
 /* Require a secondary node whose replication lag is within two minutes of the primary */
 var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, ['maxStalenessSeconds' => 120]));
 
+/* Explicitly enable server hedged reads */
+var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY, null, ['hedge' => ['enabled' => true]]));
+
 ?>
 ]]>
    </programlisting>
@@ -258,6 +275,15 @@ object(MongoDB\Driver\ReadPreference)#1 (2) {
   ["maxStalenessSeconds"]=>
   int(120)
 }
+object(MongoDB\Driver\ReadPreference)#1 (2) {
+  ["mode"]=>
+  string(9) "secondary"
+  ["hedge"]=>
+  object(stdClass)#1 (1) {
+    ["enabled"]=>
+    bool(true)
+  }
+}
 ]]>
    </screen>
   </example>

reference/mongodb/mongodb/driver/readpreference/gethedge.xml

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 342988 $ -->
+
+<refentry xml:id="mongodb-driver-readpreference.gethedge" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoDB\Driver\ReadPreference::getHedge</refname>
+  <refpurpose>Returns the ReadPreference&apos;s "hedge" option</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>final</modifier> <modifier>public</modifier> <type>object|null</type><methodname>MongoDB\Driver\ReadPreference::getHedge</methodname>
+   <void />
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the ReadPreference&apos;s "hedge" option.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simplelist>
+   &mongodb.throws.argumentparsing;
+  </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><link xlink:href="&url.mongodb.docs.readpreference;">Read Preference reference</link></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
+indent-tabs-mode:nil
+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
+-->

reference/mongodb/versions.xml

@@ -79,6 +79,7 @@
  <function name='mongodb\driver\readpreference' from='mongodb &gt;=1.0.0'/>
  <function name='mongodb\driver\readpreference::__construct' from='mongodb &gt;=1.0.0'/>
  <function name='mongodb\driver\readpreference::bsonserialize' from='mongodb &gt;=1.2.0'/>
+ <function name='mongodb\driver\readpreference::gethedge' from='mongodb &gt;=1.8.0'/>
  <function name='mongodb\driver\readpreference::getmaxstalenessseconds' from='mongodb &gt;=1.2.0'/>
  <function name='mongodb\driver\readpreference::getmode' from='mongodb &gt;=1.0.0'/>
  <function name='mongodb\driver\readpreference::getmodestring' from='mongodb &gt;=1.7.0'/>