svn: /phpdoc/en/trunk/reference/mongo/mongo/ getpoolsize.xml
| From: | Kristina Chodorow | Date: | Fri, 08 Jul 2011 21:02:27 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mongo/mongo/ getpoolsize.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-8452@lists.php.net to get a copy of this message | ||
kristina Fri, 08 Jul 2011 21:02:27 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=313080
Log:
added example and "see also" section
Changed paths:
UU phpdoc/en/trunk/reference/mongo/mongo/getpoolsize.xml
Modified: phpdoc/en/trunk/reference/mongo/mongo/getpoolsize.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongo/getpoolsize.xml 2011-07-08 19:57:39 UTC (rev 313079)
+++ phpdoc/en/trunk/reference/mongo/mongo/getpoolsize.xml 2011-07-08 21:02:27 UTC (rev 313080)
@@ -6,26 +6,74 @@
<refname>Mongo::getPoolSize</refname>
<refpurpose>Get pool size for connection pools</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>int</type><methodname>Mongo::getPoolSize</methodname>
+ <modifier>public</modifier> <modifier>static</modifier>
<type>int</type><methodname>Mongo::getPoolSize</methodname>
<void/>
</methodsynopsis>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current pool size.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Changing pool size</title>
+ <para>
+ This returns the default pool size, sets a new pool size, then prints the
+ new pool size and the pool debugging information. Note that changing the
+ pool size only affects new connection pools, it does not change old ones.
+ </para>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$connection = new Mongo("host1");
+
+// pool size is -1
+echo "pool size is: ".Mongo::getPoolSize()."\n";
+
+echo "setting pool size to 200\n";
+
+Mongo::setPoolSize(200);
+
+// pool size is 200
+echo "pool size is: ".Mongo::getPoolSize()."\n";
+
+$conn2 = new Mongo("host2");
+
+// remaining for host1 is -2
+// remaining for host2 is 199
+var_dump(Mongo::poolDebug());
+
+?>
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>Mongo::setPoolSize</function></member>
+ <member><function>Mongo::poolDebug</function></member>
+ <member>The <link linkend="mongo.connecting">connection</link>
documentation.</member>
+ </simplelist>
+ </para>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Property changes on: phpdoc/en/trunk/reference/mongo/mongo/getpoolsize.xml
___________________________________________________________________
Added: svn:eol-style
+ native