php-doc-en/reference/posix/functions/posix-times.xml
2021-06-13 13:05:33 +03:00

124 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-times" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>posix_times</refname>
<refpurpose>Get process times</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>posix_times</methodname>
<void/>
</methodsynopsis>
<para>
Gets information about the current CPU usage.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a hash of strings with information about the current
process CPU usage. The indices of the hash are:
<itemizedlist>
<listitem>
<simpara>
ticks - the number of clock ticks that have elapsed since
reboot.
</simpara>
</listitem>
<listitem>
<simpara>
utime - user time used by the current process.
</simpara>
</listitem>
<listitem>
<simpara>
stime - system time used by the current process.
</simpara>
</listitem>
<listitem>
<simpara>
cutime - user time used by current process and children.
</simpara>
</listitem>
<listitem>
<simpara>
cstime - system time used by current process and children.
</simpara>
</listitem>
</itemizedlist>
The function returns &false; on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example use of <function>posix_times</function></title>
<programlisting role="php">
<![CDATA[
<?php
$times = posix_times();
print_r($times);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[ticks] => 25814410
[utime] => 1
[stime] => 1
[cutime] => 0
[cstime] => 0
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
This function isn't reliable to use, it may return negative values for
high times.
</para>
</warning>
</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
-->