mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
- add pecl/win32ps docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201888 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Wallner
parent
62f9ac105b
commit
2f9d17028a
4 changed files with 426 additions and 0 deletions
54
reference/win32ps/functions/win32-ps-list-procs.xml
Normal file
54
reference/win32ps/functions/win32-ps-list-procs.xml
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.win32-ps-list-procs">
|
||||
<refnamediv>
|
||||
<refname>win32_ps_list_procs</refname>
|
||||
<refpurpose>List running processes</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>win32_ps_list_procs</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves statistics about all running processes.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &false; on failure, or an array consisting of process statistics like
|
||||
<function>win32_ps_stat_proc</function> returns for all running processes on success.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>win32_ps_stat_proc</function></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
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../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
|
||||
-->
|
||||
114
reference/win32ps/functions/win32-ps-stat-mem.xml
Normal file
114
reference/win32ps/functions/win32-ps-stat-mem.xml
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.win32-ps-stat-mem">
|
||||
<refnamediv>
|
||||
<refname>win32_ps_stat_mem</refname>
|
||||
<refpurpose>Stat memory utilization</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>win32_ps_stat_mem</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves statistics about the global memory utilization.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &false; on failure, or an array consisting of the
|
||||
following information on success:
|
||||
</para>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>load</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The current memory load in percent of physical memory.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>unit</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
This is always 1024, and indicates that the following values are the count of 1024 bytes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>total_phys</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of total physical memory.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>avail_phys</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of still available physical memory.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>total_pagefile</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of total pageable memory (physical memory + paging file).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>avail_pagefile</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of still available pageable memory (physical memory + paging file).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>total_virtual</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of total virtual memory for a process.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>avail_virtual</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of still available virtual memory for a process.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</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:"../../../../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
|
||||
-->
|
||||
115
reference/win32ps/functions/win32-ps-stat-proc.xml
Normal file
115
reference/win32ps/functions/win32-ps-stat-proc.xml
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.win32-ps-stat-proc">
|
||||
<refnamediv>
|
||||
<refname>win32_ps_stat_proc</refname>
|
||||
<refpurpose>Stat process</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>win32_ps_stat_proc</methodname>
|
||||
<methodparam choice="opt"><type>int</type><parameter>pid</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves statistics about the process with the process id <parameter>pid</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pid</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The process id of the process to stat. If omitted, the id of the current process.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &false; on failure, or an array consisting of the
|
||||
following information on success:
|
||||
</para>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pid</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The process id.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>exe</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The path to the executable image.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>mem</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array containing information about the following memory utilization indicators:
|
||||
<parameter>page_fault_count</parameter>,
|
||||
<parameter>peak_working_set_size</parameter>,
|
||||
<parameter>working_set_size</parameter>,
|
||||
<parameter>quota_peak_paged_pool_usage</parameter>,
|
||||
<parameter>quota_paged_pool_usage</parameter>,
|
||||
<parameter>quota_peak_non_paged_pool_usage</parameter>,
|
||||
<parameter>quota_non_paged_pool_usage</parameter>,
|
||||
<parameter>pagefile_usage</parameter> and
|
||||
<parameter>peak_pagefile_usage</parameter>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>tms</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array containing information about the following CPU time utilization indicators:
|
||||
<parameter>created</parameter>, <parameter>kernel</parameter> and <parameter>user</parameter>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>win32_ps_list_procs</function></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
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../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
|
||||
-->
|
||||
143
reference/win32ps/reference.xml
Normal file
143
reference/win32ps/reference.xml
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Purpose: utilspec.windows -->
|
||||
<!-- Membership: pecl -->
|
||||
|
||||
<reference id="ref.win32ps">
|
||||
<title>win32ps Functions</title>
|
||||
<titleabbrev>win32ps</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<section id="win32ps.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
The win32ps extension is a Windows specific extension that allows PHP
|
||||
retrieve statistics about process and memory utilization.
|
||||
</para>
|
||||
</section>
|
||||
<section id="win32ps.requirements">
|
||||
&reftitle.required;
|
||||
<para>
|
||||
Windows NT, Windows 2000, Windows XP or Windows Server 2003.
|
||||
Any version of Windows derived from Windows NT should be compatible.
|
||||
</para>
|
||||
</section>
|
||||
<section id="win32ps.install">
|
||||
&reftitle.install;
|
||||
<procedure id="win32ps.install-from-pecl">
|
||||
<title>Installing from PECL</title>
|
||||
<step>
|
||||
<para>
|
||||
You can download php_win32ps.dll from <ulink url="&url.pecl.win;">pecl4win.php.net</ulink>.
|
||||
</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Copy the php_win32ps.dll into your <link
|
||||
linkend="ini.extension-dir">extension_dir</link>.
|
||||
</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Load the extension from your &php.ini;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
extension=php_win32ps.dll
|
||||
]]>
|
||||
</screen>
|
||||
</para>
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
|
||||
<section id="win32ps.examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>Statistics about the current PHP process</title>
|
||||
<programlisting role='php'>
|
||||
<![CDATA[
|
||||
<?php
|
||||
print_r(win32_ps_stat_proc());
|
||||
/*
|
||||
Array
|
||||
(
|
||||
[pid] => 936
|
||||
[exe] => D:\Daten\Source\php-5.1\Debug_TS\php.exe
|
||||
[mem] => Array
|
||||
(
|
||||
[page_fault_count] => 2062
|
||||
[peak_working_set_size] => 8396800
|
||||
[working_set_size] => 8396800
|
||||
[quota_peak_paged_pool_usage] => 32080
|
||||
[quota_paged_pool_usage] => 31876
|
||||
[quota_peak_non_paged_pool_usage] => 4240
|
||||
[quota_non_paged_pool_usage] => 3888
|
||||
[pagefile_usage] => 5865472
|
||||
[peak_pagefile_usage] => 5865472
|
||||
)
|
||||
|
||||
[tms] => Array
|
||||
(
|
||||
[created] => 0.093
|
||||
[kernel] => 0.015
|
||||
[user] => 0.062
|
||||
)
|
||||
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Statistics about global memory utilization</title>
|
||||
<programlisting role='php'>
|
||||
<![CDATA[
|
||||
<?php
|
||||
print_r(win32_ps_stat_mem());
|
||||
/*
|
||||
Array
|
||||
(
|
||||
[load] => 37
|
||||
[unit] => 1024
|
||||
[total_phys] => 1048096
|
||||
[avail_phys] => 649960
|
||||
[total_pagefile] => 2521368
|
||||
[avail_pagefile] => 2237940
|
||||
[total_virtual] => 2097024
|
||||
[avail_virtual] => 2057848
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</section>
|
||||
</partintro>
|
||||
&reference.win32ps.functions;
|
||||
</reference>
|
||||
|
||||
<!-- 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:"../../../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
|
||||
-->
|
||||
Loading…
Reference in a new issue