php-doc-en/reference/mongo/mongopool/setsize.xml

<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->
<refentry xml:id="mongopool.setsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoPool::setSize</refname>
  <refpurpose>Set the size for future connection pools.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>MongoPool::setSize</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>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>size</parameter>
     </term>
     <listitem>
      <para>
       The max number of connections future pools will be able to create.
       Negative numbers mean that the pool will spawn an infinite number of
       connections.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the former value of pool size.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>1.2.11</entry>
       <entry>Emits <constant>E_DEPRECATED</constant> when used.</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>


 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="mongopool.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
MongoPool::setSize(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>MongoPool::getSize</function></member>
    <member><function>MongoPool::info</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:
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
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
-->