flush
authorMichael Wallner <mike@php.net>
Tue, 5 Nov 2013 11:14:13 +0000 (12:14 +0100)
committerMichael Wallner <mike@php.net>
Tue, 5 Nov 2013 11:14:13 +0000 (12:14 +0100)
raphf.md [new file with mode: 0644]
raphf/clean_persistent_handles.md [new file with mode: 0644]
raphf/stat_persistent_handles.md [new file with mode: 0644]

diff --git a/raphf.md b/raphf.md
new file mode 100644 (file)
index 0000000..5b112a2
--- /dev/null
+++ b/raphf.md
@@ -0,0 +1,18 @@
+# pecl/raphf
+
+## About:
+
+The **"Resource and Persistent Handle Factory"** extension provides facilities to manage those in a convenient manner.
+
+> **Note:** This extension mostly only provides infrastructure for other extensions.
+
+## Installation:
+
+This extension is hosted at PECL (<http://pecl.php.net>) and can be installed eith PEAR's pecl command:
+
+    # pecl install raphf
+
+## INI Directives:
+
+* raphf.persistent_handle.limit = -1  
+  The per process/thread persistent handle limit.
diff --git a/raphf/clean_persistent_handles.md b/raphf/clean_persistent_handles.md
new file mode 100644 (file)
index 0000000..ad8a8ac
--- /dev/null
@@ -0,0 +1,14 @@
+# void raphf\clean_persistent_handles([string name = NULL[, string $ident]])
+
+Clean persistent handles whith id $name->$ident.
+
+## Params
+
+* Optional string $name = NULL  
+  The persistent handle id.
+* Optional string $ident = NULL  
+  The unique identifier within the persistent handle id.
+
+## Example:
+
+    raphf\clean_persistent_handles("http\\Client\\Curl\\Request", "php.net:80");
diff --git a/raphf/stat_persistent_handles.md b/raphf/stat_persistent_handles.md
new file mode 100644 (file)
index 0000000..7764187
--- /dev/null
@@ -0,0 +1,37 @@
+# object raphf\stat_persistent_handles()
+
+Retrieve statistics about current process'/thread's persistent handles.
+
+## Params:
+
+None.
+
+## Returns:
+
+* object, stdClass instance
+
+
+## Example:
+
+    var_dump(raphf\stat_persistent_handles());
+
+Yields:
+
+    object(stdClass)#6 (3) {
+        ["http\Client\Curl"]=>
+        array(0) {
+        }
+        ["http\Client\Curl\Request"]=>
+        array(1) {
+        ["php.net:80"]=>
+        array(2) {
+          ["used"]=>
+          int(2)
+          ["free"]=>
+          int(1)
+        }
+        }
+        ["pq\Connection"]=>
+        array(0) {
+        }
+    }