mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Added example and "see also" section
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313486 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
be318032a3
commit
f837c25b02
1 changed files with 60 additions and 5 deletions
|
@ -6,19 +6,19 @@
|
|||
<refname>Mongo::setPoolSize</refname>
|
||||
<refpurpose>Set the size for future connection pools.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>bool</type><methodname>Mongo::setPoolSize</methodname>
|
||||
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>Mongo::setPoolSize</methodname>
|
||||
<methodparam><type>int</type><parameter>size</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
|
||||
<para>
|
||||
Sets the max number of connections new pools will be able to create.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
|
@ -38,13 +38,68 @@
|
|||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the former value of pool size.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples"><!-- {{{ -->
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example xml:id="mongo.setpoolsize.example.basic"><!-- {{{ -->
|
||||
<title><function>Mongo::setPoolSize</function> example</title>
|
||||
<para>
|
||||
If you set the pool size to <literal>n</literal> and then create
|
||||
<literal>n</literal> connections, attempting to create an
|
||||
<literal>n+1</literal>st connection will throw a
|
||||
<classname>MongoConnectionException</classname>.
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
// only allow one connection to a server
|
||||
Mongo::setPoolSize(1);
|
||||
|
||||
// creates one connection to localhost:27017
|
||||
$m1 = new Mongo();
|
||||
|
||||
// attempt to create a second connection to localhost:27017
|
||||
// only one connection is allowed, so this will throw an exception
|
||||
$m2 = new Mongo();
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Fatal error: Uncaught exception 'MongoConnectionException' with message 'no more connections in pool' in /path/to/php/script.php:10
|
||||
Stack trace:
|
||||
#0 /path/to/php/script.php(10): Mongo->__construct()
|
||||
#1 {main}
|
||||
thrown in /path/to/php/script.php on line 10
|
||||
]]>
|
||||
</screen>
|
||||
</example><!-- }}} -->
|
||||
</para>
|
||||
</refsect1><!-- }}} -->
|
||||
|
||||
|
||||
<refsect1 role="seealso"><!-- {{{ -->
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>Mongo::getPoolSize</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:
|
||||
|
|
Loading…
Reference in a new issue