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

<refentry xml:id="thread.getpeak" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Thread::getPeak</refname>
  <refpurpose>Return the peak number of Threads.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>Thread::getPeak</methodname>
   <void />
  </methodsynopsis>
  <para>
 Return the peak number of Threads executing concurrently in the current instance of PHP.
 Some system administrators choose to limit the amount of Threads an instance of PHP can create.
 If enabled the maximum number of Threads the current instance can create is returned by a call to <function>Thread::getMax</function>.
  </para>
  <para>What counts as "an instance of PHP" depends on the current environment PHP and pthreads are executing in.</para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>The peak number of Threads the current of PHP has executed.</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
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
-->