From 2f9d17028a9213a24e78dcff8d2f3dae01cf0552 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Fri, 2 Dec 2005 15:05:02 +0000 Subject: [PATCH] - add pecl/win32ps docs git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201888 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../win32ps/functions/win32-ps-list-procs.xml | 54 +++++++ .../win32ps/functions/win32-ps-stat-mem.xml | 114 ++++++++++++++ .../win32ps/functions/win32-ps-stat-proc.xml | 115 ++++++++++++++ reference/win32ps/reference.xml | 143 ++++++++++++++++++ 4 files changed, 426 insertions(+) create mode 100644 reference/win32ps/functions/win32-ps-list-procs.xml create mode 100644 reference/win32ps/functions/win32-ps-stat-mem.xml create mode 100644 reference/win32ps/functions/win32-ps-stat-proc.xml create mode 100644 reference/win32ps/reference.xml diff --git a/reference/win32ps/functions/win32-ps-list-procs.xml b/reference/win32ps/functions/win32-ps-list-procs.xml new file mode 100644 index 0000000000..092e353e2d --- /dev/null +++ b/reference/win32ps/functions/win32-ps-list-procs.xml @@ -0,0 +1,54 @@ + + + + + win32_ps_list_procs + List running processes + + + &reftitle.description; + + arraywin32_ps_list_procs + + + + Retrieves statistics about all running processes. + + + + &reftitle.returnvalues; + + Returns &false; on failure, or an array consisting of process statistics like + win32_ps_stat_proc returns for all running processes on success. + + + + &reftitle.seealso; + + + win32_ps_stat_proc + + + + + + diff --git a/reference/win32ps/functions/win32-ps-stat-mem.xml b/reference/win32ps/functions/win32-ps-stat-mem.xml new file mode 100644 index 0000000000..8f15fce1ce --- /dev/null +++ b/reference/win32ps/functions/win32-ps-stat-mem.xml @@ -0,0 +1,114 @@ + + + + + win32_ps_stat_mem + Stat memory utilization + + + &reftitle.description; + + arraywin32_ps_stat_mem + + + + Retrieves statistics about the global memory utilization. + + + + &reftitle.returnvalues; + + Returns &false; on failure, or an array consisting of the + following information on success: + + + + + load + + + The current memory load in percent of physical memory. + + + + + unit + + + This is always 1024, and indicates that the following values are the count of 1024 bytes. + + + + + total_phys + + + The amount of total physical memory. + + + + + avail_phys + + + The amount of still available physical memory. + + + + + total_pagefile + + + The amount of total pageable memory (physical memory + paging file). + + + + + avail_pagefile + + + The amount of still available pageable memory (physical memory + paging file). + + + + + total_virtual + + + The amount of total virtual memory for a process. + + + + + avail_virtual + + + The amount of still available virtual memory for a process. + + + + + + + + + diff --git a/reference/win32ps/functions/win32-ps-stat-proc.xml b/reference/win32ps/functions/win32-ps-stat-proc.xml new file mode 100644 index 0000000000..711542e74e --- /dev/null +++ b/reference/win32ps/functions/win32-ps-stat-proc.xml @@ -0,0 +1,115 @@ + + + + + win32_ps_stat_proc + Stat process + + + &reftitle.description; + + arraywin32_ps_stat_proc + intpid + + + Retrieves statistics about the process with the process id pid. + + + + &reftitle.parameters; + + + + pid + + + The process id of the process to stat. If omitted, the id of the current process. + + + + + + + + &reftitle.returnvalues; + + Returns &false; on failure, or an array consisting of the + following information on success: + + + + + pid + + + The process id. + + + + + exe + + + The path to the executable image. + + + + + mem + + + An array containing information about the following memory utilization indicators: + page_fault_count, + peak_working_set_size, + working_set_size, + quota_peak_paged_pool_usage, + quota_paged_pool_usage, + quota_peak_non_paged_pool_usage, + quota_non_paged_pool_usage, + pagefile_usage and + peak_pagefile_usage. + + + + + tms + + + An array containing information about the following CPU time utilization indicators: + created, kernel and user. + + + + + + + + &reftitle.seealso; + + + win32_ps_list_procs + + + + + + diff --git a/reference/win32ps/reference.xml b/reference/win32ps/reference.xml new file mode 100644 index 0000000000..1173e8f7d0 --- /dev/null +++ b/reference/win32ps/reference.xml @@ -0,0 +1,143 @@ + + + + + + + win32ps Functions + win32ps + + +
+ &reftitle.intro; + + The win32ps extension is a Windows specific extension that allows PHP + retrieve statistics about process and memory utilization. + +
+
+ &reftitle.required; + + Windows NT, Windows 2000, Windows XP or Windows Server 2003. + Any version of Windows derived from Windows NT should be compatible. + +
+
+ &reftitle.install; + + Installing from PECL + + + You can download php_win32ps.dll from pecl4win.php.net. + + + + + Copy the php_win32ps.dll into your extension_dir. + + + + + Load the extension from your &php.ini; + + + + + + +
+ +
+ &reftitle.examples; + + + Statistics about the current PHP process + + 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 + ) + + ) +*/ +?> +]]> + + + + + + Statistics about global memory utilization + + 37 + [unit] => 1024 + [total_phys] => 1048096 + [avail_phys] => 649960 + [total_pagefile] => 2521368 + [avail_pagefile] => 2237940 + [total_virtual] => 2097024 + [avail_virtual] => 2057848 + ) +*/ +?> +]]> + + + +
+ + &reference.win32ps.functions; + + +